-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathclassrpc__hpp_1_1server_1_1server__interface.html
475 lines (453 loc) · 26.1 KB
/
classrpc__hpp_1_1server_1_1server__interface.html
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
<!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">
<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>rpc.hpp: rpc_hpp::server::server_interface< Serial > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.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>
<link href="doxygen.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">rpc.hpp<span id="projectnumber"> 0.8.1</span>
</div>
<div id="projectbrief">Simple RPC Header-Only Library</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&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&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacerpc__hpp.html">rpc_hpp</a></li><li class="navelem"><a class="el" href="namespacerpc__hpp_1_1server.html">server</a></li><li class="navelem"><a class="el" href="classrpc__hpp_1_1server_1_1server__interface.html">server_interface</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-static-methods">Static Protected Member Functions</a> |
<a href="classrpc__hpp_1_1server_1_1server__interface-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">rpc_hpp::server::server_interface< Serial > Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Class defining an interface for serving functions via RPC.
<a href="classrpc__hpp_1_1server_1_1server__interface.html#details">More...</a></p>
<p><code>#include <<a class="el" href="rpc_8hpp_source.html">rpc.hpp</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a6ccb446079f29f7b21e339ede687e035"><td class="memItemLeft" align="right" valign="top"><a id="a6ccb446079f29f7b21e339ede687e035" name="a6ccb446079f29f7b21e339ede687e035"></a>
using </td><td class="memItemRight" valign="bottom"><b>adapter_t</b> = Serial</td></tr>
<tr class="separator:a6ccb446079f29f7b21e339ede687e035"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2be7fb66a202537bc6270c5e8f10503c"><td class="memItemLeft" align="right" valign="top"><a id="a2be7fb66a202537bc6270c5e8f10503c" name="a2be7fb66a202537bc6270c5e8f10503c"></a>
 </td><td class="memItemRight" valign="bottom"><b>server_interface</b> (const <a class="el" href="classrpc__hpp_1_1server_1_1server__interface.html">server_interface</a> &)=delete</td></tr>
<tr class="separator:a2be7fb66a202537bc6270c5e8f10503c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2e917a4d3a2ca9fb9f43c46032f8159d"><td class="memItemLeft" align="right" valign="top"><a id="a2e917a4d3a2ca9fb9f43c46032f8159d" name="a2e917a4d3a2ca9fb9f43c46032f8159d"></a>
<a class="el" href="classrpc__hpp_1_1server_1_1server__interface.html">server_interface</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classrpc__hpp_1_1server_1_1server__interface.html">server_interface</a> &)=delete</td></tr>
<tr class="separator:a2e917a4d3a2ca9fb9f43c46032f8159d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b87e2a752229f2bdd48b2a291207e0c"><td class="memItemLeft" align="right" valign="top"><a id="a0b87e2a752229f2bdd48b2a291207e0c" name="a0b87e2a752229f2bdd48b2a291207e0c"></a>
 </td><td class="memItemRight" valign="bottom"><b>server_interface</b> (<a class="el" href="classrpc__hpp_1_1server_1_1server__interface.html">server_interface</a> &&) noexcept=default</td></tr>
<tr class="separator:a0b87e2a752229f2bdd48b2a291207e0c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab1cf8dc347e9040cda008a86262a8df6"><td class="memItemLeft" align="right" valign="top"><a id="ab1cf8dc347e9040cda008a86262a8df6" name="ab1cf8dc347e9040cda008a86262a8df6"></a>
<a class="el" href="classrpc__hpp_1_1server_1_1server__interface.html">server_interface</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classrpc__hpp_1_1server_1_1server__interface.html">server_interface</a> &&) noexcept=default</td></tr>
<tr class="separator:ab1cf8dc347e9040cda008a86262a8df6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a13615fb623581c4efe4eea83ddc0530f"><td class="memTemplParams" colspan="2">template<typename Val > </td></tr>
<tr class="memitem:a13615fb623581c4efe4eea83ddc0530f"><td class="memTemplItemLeft" align="right" valign="top">std::unordered_map< typename Serial::bytes_t, Val > & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classrpc__hpp_1_1server_1_1server__interface.html#a13615fb623581c4efe4eea83ddc0530f">get_func_cache</a> (const std::string &func_name)</td></tr>
<tr class="memdesc:a13615fb623581c4efe4eea83ddc0530f"><td class="mdescLeft"> </td><td class="mdescRight">Gets a reference to the server's function cache. <a href="classrpc__hpp_1_1server_1_1server__interface.html#a13615fb623581c4efe4eea83ddc0530f">More...</a><br /></td></tr>
<tr class="separator:a13615fb623581c4efe4eea83ddc0530f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adca486c77d3c2f02edafe60b63a4dede"><td class="memItemLeft" align="right" valign="top"><a id="adca486c77d3c2f02edafe60b63a4dede" name="adca486c77d3c2f02edafe60b63a4dede"></a>
RPC_HPP_INLINE void </td><td class="memItemRight" valign="bottom"><b>clear_all_cache</b> () noexcept</td></tr>
<tr class="memdesc:adca486c77d3c2f02edafe60b63a4dede"><td class="mdescLeft"> </td><td class="mdescRight">Clears the server's function cache. <br /></td></tr>
<tr class="separator:adca486c77d3c2f02edafe60b63a4dede"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad3d4b0e1529e5fc308fb9615427edcf6"><td class="memTemplParams" colspan="2">template<typename R , typename... Args> </td></tr>
<tr class="memitem:ad3d4b0e1529e5fc308fb9615427edcf6"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classrpc__hpp_1_1server_1_1server__interface.html#ad3d4b0e1529e5fc308fb9615427edcf6">bind_cached</a> (std::string func_name, R(*func_ptr)(Args...))</td></tr>
<tr class="memdesc:ad3d4b0e1529e5fc308fb9615427edcf6"><td class="mdescLeft"> </td><td class="mdescRight">Binds a string to a callback, utilizing the server's cache. <a href="classrpc__hpp_1_1server_1_1server__interface.html#ad3d4b0e1529e5fc308fb9615427edcf6">More...</a><br /></td></tr>
<tr class="separator:ad3d4b0e1529e5fc308fb9615427edcf6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a01338b33886f4ece665c0c1ccfa613e8"><td class="memTemplParams" colspan="2">template<typename R , typename... Args, typename F > </td></tr>
<tr class="memitem:a01338b33886f4ece665c0c1ccfa613e8"><td class="memTemplItemLeft" align="right" valign="top">RPC_HPP_INLINE void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classrpc__hpp_1_1server_1_1server__interface.html#a01338b33886f4ece665c0c1ccfa613e8">bind_cached</a> (std::string func_name, F &&func)</td></tr>
<tr class="memdesc:a01338b33886f4ece665c0c1ccfa613e8"><td class="mdescLeft"> </td><td class="mdescRight">Binds a string to a callback, utilizing the server's cache. <a href="classrpc__hpp_1_1server_1_1server__interface.html#a01338b33886f4ece665c0c1ccfa613e8">More...</a><br /></td></tr>
<tr class="separator:a01338b33886f4ece665c0c1ccfa613e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a396b02c90c5a94f8cb8aa964b4e0f568"><td class="memTemplParams" colspan="2">template<typename R , typename... Args> </td></tr>
<tr class="memitem:a396b02c90c5a94f8cb8aa964b4e0f568"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classrpc__hpp_1_1server_1_1server__interface.html#a396b02c90c5a94f8cb8aa964b4e0f568">bind</a> (std::string func_name, R(*func_ptr)(Args...))</td></tr>
<tr class="memdesc:a396b02c90c5a94f8cb8aa964b4e0f568"><td class="mdescLeft"> </td><td class="mdescRight">Binds a string to a callback. <a href="classrpc__hpp_1_1server_1_1server__interface.html#a396b02c90c5a94f8cb8aa964b4e0f568">More...</a><br /></td></tr>
<tr class="separator:a396b02c90c5a94f8cb8aa964b4e0f568"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aad03f7ee3b44798e995fef318070ffc5"><td class="memTemplParams" colspan="2">template<typename R , typename... Args, typename F > </td></tr>
<tr class="memitem:aad03f7ee3b44798e995fef318070ffc5"><td class="memTemplItemLeft" align="right" valign="top">RPC_HPP_INLINE void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classrpc__hpp_1_1server_1_1server__interface.html#aad03f7ee3b44798e995fef318070ffc5">bind</a> (std::string func_name, F &&func)</td></tr>
<tr class="memdesc:aad03f7ee3b44798e995fef318070ffc5"><td class="mdescLeft"> </td><td class="mdescRight">Binds a string to a callback. <a href="classrpc__hpp_1_1server_1_1server__interface.html#aad03f7ee3b44798e995fef318070ffc5">More...</a><br /></td></tr>
<tr class="separator:aad03f7ee3b44798e995fef318070ffc5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a24bb7ca7f3add539f8247f425efd64a1"><td class="memItemLeft" align="right" valign="top">Serial::bytes_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classrpc__hpp_1_1server_1_1server__interface.html#a24bb7ca7f3add539f8247f425efd64a1">dispatch</a> (typename Serial::bytes_t &&bytes) const</td></tr>
<tr class="memdesc:a24bb7ca7f3add539f8247f425efd64a1"><td class="mdescLeft"> </td><td class="mdescRight">Parses the received serialized data and determines which function to call. <a href="classrpc__hpp_1_1server_1_1server__interface.html#a24bb7ca7f3add539f8247f425efd64a1">More...</a><br /></td></tr>
<tr class="separator:a24bb7ca7f3add539f8247f425efd64a1"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a87b78e0353d6257b2a20933d8498cb65"><td class="memTemplParams" colspan="2"><a id="a87b78e0353d6257b2a20933d8498cb65" name="a87b78e0353d6257b2a20933d8498cb65"></a>
template<typename R , typename... Args> </td></tr>
<tr class="memitem:a87b78e0353d6257b2a20933d8498cb65"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>dispatch_cached_func</b> (R(*func)(Args...), typename Serial::serial_t &serial_obj)</td></tr>
<tr class="separator:a87b78e0353d6257b2a20933d8498cb65"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-static-methods" name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr class="memitem:aeba3d7238ed85e671aad83a551e86814"><td class="memTemplParams" colspan="2"><a id="aeba3d7238ed85e671aad83a551e86814" name="aeba3d7238ed85e671aad83a551e86814"></a>
template<typename R , typename... Args> </td></tr>
<tr class="memitem:aeba3d7238ed85e671aad83a551e86814"><td class="memTemplItemLeft" align="right" valign="top">static void </td><td class="memTemplItemRight" valign="bottom"><b>dispatch_func</b> (R(*func)(Args...), typename Serial::serial_t &serial_obj)</td></tr>
<tr class="separator:aeba3d7238ed85e671aad83a551e86814"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template<typename Serial><br />
class rpc_hpp::server::server_interface< Serial ></div><p >Class defining an interface for serving functions via RPC. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Serial</td><td>serial_adapter type that controls how objects are serialized/deserialized </td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aad03f7ee3b44798e995fef318070ffc5" name="aad03f7ee3b44798e995fef318070ffc5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad03f7ee3b44798e995fef318070ffc5">◆ </a></span>bind() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Serial > </div>
<div class="memtemplate">
template<typename R , typename... Args, typename F > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">RPC_HPP_INLINE void <a class="el" href="classrpc__hpp_1_1server_1_1server__interface.html">rpc_hpp::server::server_interface</a>< Serial >::bind </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>func_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">F && </td>
<td class="paramname"><em>func</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Binds a string to a callback. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">R</td><td>Return type of the callback function </td></tr>
<tr><td class="paramname">Args</td><td>Variadic argument type(s) for the function </td></tr>
<tr><td class="paramname">F</td><td>Callback type (could be function or lambda or functor) </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">func_name</td><td>Name to bind the callback to </td></tr>
<tr><td class="paramname">func</td><td>Callback to run when dispatch is called with bound name </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a396b02c90c5a94f8cb8aa964b4e0f568" name="a396b02c90c5a94f8cb8aa964b4e0f568"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a396b02c90c5a94f8cb8aa964b4e0f568">◆ </a></span>bind() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Serial > </div>
<div class="memtemplate">
template<typename R , typename... Args> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classrpc__hpp_1_1server_1_1server__interface.html">rpc_hpp::server::server_interface</a>< Serial >::bind </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>func_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">R(*)(Args...) </td>
<td class="paramname"><em>func_ptr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Binds a string to a callback. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">R</td><td>Return type of the callback function </td></tr>
<tr><td class="paramname">Args</td><td>Variadic argument type(s) for the function </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">func_name</td><td>Name to bind the callback to </td></tr>
<tr><td class="paramname">func_ptr</td><td>Pointer to callback that runs when dispatch is called with bound name </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a01338b33886f4ece665c0c1ccfa613e8" name="a01338b33886f4ece665c0c1ccfa613e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01338b33886f4ece665c0c1ccfa613e8">◆ </a></span>bind_cached() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Serial > </div>
<div class="memtemplate">
template<typename R , typename... Args, typename F > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">RPC_HPP_INLINE void <a class="el" href="classrpc__hpp_1_1server_1_1server__interface.html">rpc_hpp::server::server_interface</a>< Serial >::bind_cached </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>func_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">F && </td>
<td class="paramname"><em>func</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Binds a string to a callback, utilizing the server's cache. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">R</td><td>Return type of the callback function </td></tr>
<tr><td class="paramname">Args</td><td>Variadic argument type(s) for the function </td></tr>
<tr><td class="paramname">F</td><td>Callback type (could be function or lambda or functor) </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">func_name</td><td>Name to bind the callback to </td></tr>
<tr><td class="paramname">func</td><td>Callback to run when dispatch is called with bound name </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad3d4b0e1529e5fc308fb9615427edcf6" name="ad3d4b0e1529e5fc308fb9615427edcf6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3d4b0e1529e5fc308fb9615427edcf6">◆ </a></span>bind_cached() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Serial > </div>
<div class="memtemplate">
template<typename R , typename... Args> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classrpc__hpp_1_1server_1_1server__interface.html">rpc_hpp::server::server_interface</a>< Serial >::bind_cached </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>func_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">R(*)(Args...) </td>
<td class="paramname"><em>func_ptr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Binds a string to a callback, utilizing the server's cache. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">R</td><td>Return type of the callback function </td></tr>
<tr><td class="paramname">Args</td><td>Variadic argument type(s) for the function </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">func_name</td><td>Name to bind the callback to </td></tr>
<tr><td class="paramname">func_ptr</td><td>Pointer to callback that runs when dispatch is called with bound name </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a24bb7ca7f3add539f8247f425efd64a1" name="a24bb7ca7f3add539f8247f425efd64a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24bb7ca7f3add539f8247f425efd64a1">◆ </a></span>dispatch()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Serial > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Serial::bytes_t <a class="el" href="classrpc__hpp_1_1server_1_1server__interface.html">rpc_hpp::server::server_interface</a>< Serial >::dispatch </td>
<td>(</td>
<td class="paramtype">typename Serial::bytes_t && </td>
<td class="paramname"><em>bytes</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Parses the received serialized data and determines which function to call. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bytes</td><td>Data to be parsed into a serial object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Serial::bytes_t Data parsed out of a serial object after dispatching the callback </dd></dl>
<dl class="section note"><dt>Note</dt><dd>nodiscard because original bytes are consumed </dd></dl>
</div>
</div>
<a id="a13615fb623581c4efe4eea83ddc0530f" name="a13615fb623581c4efe4eea83ddc0530f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13615fb623581c4efe4eea83ddc0530f">◆ </a></span>get_func_cache()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Serial > </div>
<div class="memtemplate">
template<typename Val > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::unordered_map< typename Serial::bytes_t, Val > & <a class="el" href="classrpc__hpp_1_1server_1_1server__interface.html">rpc_hpp::server::server_interface</a>< Serial >::get_func_cache </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>func_name</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a reference to the server's function cache. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Val</td><td>Type of the return value for a function </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">func_name</td><td>Name of the function to get the cached return value(s) for </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>std::unordered_map<typename Serial::bytes_t, Val>& Reference to the hashmap containing the return values with the serialized function call as the key </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/<a class="el" href="rpc_8hpp_source.html">rpc.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>