docs/WritingServerCode.html at main · kourier-server/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
<!-- HTML header for doxygen 1.9.6-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="$langISO">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Kourier: Writing Server Code</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Ubuntu:ital,wght@0,300;0,400;0,500;0,700;1,300;1,400;1,500;1,700|Ubuntu+Mono:ital,wght@0,400;0,700;1,400;1,700|Ubuntu+Condensed|Material+Symbols+Outlined:opsz,wght,FILL,GRAD@48,400,0,0|Source+Code+Pro:ital,wght@0,200;0,300;0,400;0,500;0,600;0,700;0,800;0,900;1,200;1,300;1,400;1,500;1,600;1,700;1,800;1,900|Noto+Sans:ital,wght@0,100;0,200;0,300;0,400;0,500;0,600;0,700;0,800;0,900;1,100;1,200;1,300;1,400;1,500;1,600;1,700;1,800;1,900|Source+Sans+Pro:ital,wght@0,200;0,300;0,400;0,600;0,700;0,900;1,200;1,300;1,400;1,600;1,700;1,900" />
<link href="https://fonts.cdnfonts.com/css/bitstream-vera-sans-mono" rel="stylesheet">
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
        <script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
        <script type="text/javascript">
            DoxygenAwesomeDarkModeToggle.init()
        </script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
$darkmode
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Kourier<span id="projectnumber">&#160;1.0.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('WritingServerCode.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div><div class="header">
  <div class="headertitle"><div class="title">Writing Server Code </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p ><a class="anchor" id="md_WritingCode_WritingServerCode"></a> All classes inheriting from Cute::Server::RemoteObject can contain remote signals and slots. Remote signals and slots are standard Qt signals/slots that developers register on source files. For example, consider the <code>ContactService</code> class shown below:</p>
<div class="fragment"><div class="line"><span class="comment">//</span></div>
<div class="line"><span class="comment">// ContactService.h</span></div>
<div class="line"><span class="comment">//</span></div>
<div class="line"><span class="preprocessor">#include &lt;CuteServerSdk.h&gt;</span></div>
<div class="line"> </div>
<div class="line"><span class="keyword">using </span>Cute::Server::RemoteObject;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// ContactService is a class that will have signals and slots</span></div>
<div class="line"><span class="comment">// made available for remote signal/slot interaction, and thus</span></div>
<div class="line"><span class="comment">// must inherit from Cute::Server::RemoteObject.</span></div>
<div class="line"><span class="keyword">class </span>ContactService : <span class="keyword">public</span> RemoteObject</div>
<div class="line">{</div>
<div class="line">Q_OBJECT</div>
<div class="line"><span class="keyword">public</span> slots:</div>
<div class="line">    <span class="keywordtype">void</span> addContact(QString name, QString address);</div>
<div class="line">    QList&lt;std::pair&lt;QString,QString&gt; contacts();</div>
<div class="line">    </div>
<div class="line">signals:</div>
<div class="line">    <span class="keywordtype">void</span> newContact(<span class="keyword">const</span> QString &amp;name, <span class="keyword">const</span> QString &amp;address);</div>
<div class="line">};</div>
<div class="line"> </div>
<div class="line"><span class="comment">//</span></div>
<div class="line"><span class="comment">// ContactService.cpp</span></div>
<div class="line"><span class="comment">//</span></div>
<div class="line"><span class="preprocessor">#include &quot;ContactService.h&quot;</span></div>
<div class="line"><span class="comment">// Remote signals and slots are registered in source files</span></div>
<div class="line">Cute::registerRemoteSignal(&amp;ContactService::newContact);</div>
<div class="line">Cute::registerRemoteSlot(&amp;ContactService::addContact);</div>
<div class="line">Cute::registerRemoteSlot(&amp;ContactService::contacts);</div>
</div><!-- fragment --><p >All signals and slots from <code>ContactService</code> were made available for remote signal-slot interaction. Like Qt, Cute supports <a class="el" href="CreatingCustomTypes.html">custom types</a>. To use custom types in remote signals and slots, developers have to make the type known to <code>QMetaType</code> by declaring it with <code>Q_DECLARE_METATYPE</code> (Cute supports all template-based Qt containers and most of the template-based containers from the C++ Standard Library, which Cute registers automatically). Then, users have to register the type with Cute. Custom types must be registered on both client and server sides. Let's modify the <code>ContactService</code> class to make it use the <code>Contact</code> custom type on remote signals and slots:</p>
<div class="fragment"><div class="line"><span class="comment">//</span></div>
<div class="line"><span class="comment">// ContactService.h</span></div>
<div class="line"><span class="comment">//</span></div>
<div class="line"><span class="preprocessor">#include &lt;CuteServerSdk.h&gt;</span></div>
<div class="line"> </div>
<div class="line"><span class="keyword">using </span>Cute::DataStream;</div>
<div class="line"><span class="keyword">using </span>Cute::Server::RemoteObject;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Contact is a custom type used on</span></div>
<div class="line"><span class="comment">// remote signals and slots.</span></div>
<div class="line"><span class="keyword">struct </span>Contact</div>
<div class="line">{</div>
<div class="line">    QString name;</div>
<div class="line">    QString address;</div>
<div class="line">};</div>
<div class="line"> </div>
<div class="line"><span class="comment">// All custom types must be registered</span></div>
<div class="line"><span class="comment">// with Qt meta-type system.</span></div>
<div class="line">Q_DECLARE_METATYPE(Contact);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Custom types must define stream operators for</span></div>
<div class="line"><span class="comment">// Cute::DataStream.</span></div>
<div class="line"><span class="keyword">inline</span> DataStream &amp;operator&lt;&lt;(DataStream &amp;stream, <span class="keyword">const</span> Contact &amp;contact)</div>
<div class="line">{stream &lt;&lt; contact.name; stream &lt;&lt; contact.address; <span class="keywordflow">return</span> stream;}</div>
<div class="line"><span class="keyword">inline</span> DataStream &amp;operator&gt;&gt;(DataStream &amp;stream, Contact &amp;contact)</div>
<div class="line">{stream &gt;&gt; contact.name; stream &gt;&gt; contact.address; <span class="keywordflow">return</span> stream;}</div>
<div class="line"> </div>
<div class="line"><span class="comment">// ContactService is a class that will have signals and slots</span></div>
<div class="line"><span class="comment">// made available for remote signal/slot interaction, and thus</span></div>
<div class="line"><span class="comment">// must inherit from Cute::Server::RemoteObject.</span></div>
<div class="line"><span class="keyword">class </span>ContactService : <span class="keyword">public</span> RemoteObject</div>
<div class="line">{</div>
<div class="line">Q_OBJECT</div>
<div class="line"><span class="keyword">public</span> slots:</div>
<div class="line">    <span class="keywordtype">void</span> addContact(QString name, QString address);</div>
<div class="line">    <span class="keywordtype">void</span> addContact(<span class="keyword">const</span> Contact &amp;contact);</div>
<div class="line">    QList&lt;Contact&gt; contacts();</div>
<div class="line">    </div>
<div class="line">signals:</div>
<div class="line">    <span class="keywordtype">void</span> newContact(<span class="keyword">const</span> Contact &amp;contact);</div>
<div class="line">};</div>
<div class="line"> </div>
<div class="line"><span class="comment">//</span></div>
<div class="line"><span class="comment">// ContactService.cpp</span></div>
<div class="line"><span class="comment">//</span></div>
<div class="line"><span class="preprocessor">#include &quot;ContactService.h&quot;</span></div>
<div class="line"><span class="comment">// Both Custom types and remote signals and slots</span></div>
<div class="line"><span class="comment">// are registered in source files</span></div>
<div class="line">Cute::registerCustomType&lt;Contact&gt;();</div>
<div class="line">Cute::registerRemoteSignal(&amp;ContactService::newContact);</div>
<div class="line">Cute::registerRemoteSlot(qOverload&lt;QString,QString&gt;(&amp;ContactService::addContact));</div>
<div class="line">Cute::registerRemoteSlot(qOverload&lt;const Contact&amp;&gt;(&amp;ContactService::addContact));</div>
<div class="line">Cute::registerRemoteSlot(&amp;ContactService::contacts);</div>
</div><!-- fragment --><p >Cute does RPC the way it was always meant to be through the powerful yet intuitive interaction model it provides to developers.</p>
<p >As shown on our blog, Cute does not only empowers creators to implement networked systems quickly and easily: Cute is also the top performer in network-based communication and delivers the fastest server on Earth. </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.6-->
<!-- start footer part -->
</body>
</html>