-
Notifications
You must be signed in to change notification settings - Fork 0
/
classcc__mqttsn__gateway_1_1Gateway.html
339 lines (313 loc) · 22.9 KB
/
classcc__mqttsn__gateway_1_1Gateway.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
<!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="en-US">
<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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MQTT-SN Gateway Library: cc_mqttsn_gateway::Gateway Class 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">MQTT-SN Gateway Library
</div>
<div id="projectbrief">Library that allows implementation of MQTT-SN gateway.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacecc__mqttsn__gateway.html">cc_mqttsn_gateway</a></li><li class="navelem"><a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html">Gateway</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="classcc__mqttsn__gateway_1_1Gateway-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">cc_mqttsn_gateway::Gateway Class Reference</div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Interface for <b><a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html" title="Interface for Gateway entity.">Gateway</a></b> entity. </p>
<p>The responsibility of the <b><a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html" title="Interface for Gateway entity.">Gateway</a></b> object is to advertise its presence to all MQTT-SN clients on the network. It requests the driving code to send serialised <b>ADVERTISE</b> message periodically, using provided callback. </p>
</div><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:a8a6c83ec82aa22f872b29f4d79d5713f" id="r_a8a6c83ec82aa22f872b29f4d79d5713f"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html#a8a6c83ec82aa22f872b29f4d79d5713f">NextTickProgramReqCb</a> = std::function< void(unsigned ms)></td></tr>
<tr class="memdesc:a8a6c83ec82aa22f872b29f4d79d5713f"><td class="mdescLeft"> </td><td class="mdescRight">Type of the callback used to request time measurement. <br /></td></tr>
<tr class="separator:a8a6c83ec82aa22f872b29f4d79d5713f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a574d84b0a91a0f9b4cc7b814c6d1de14" id="r_a574d84b0a91a0f9b4cc7b814c6d1de14"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html#a574d84b0a91a0f9b4cc7b814c6d1de14">SendDataReqCb</a> = std::function< void(const std::uint8_t *buf, std::size_t bufSize)></td></tr>
<tr class="memdesc:a574d84b0a91a0f9b4cc7b814c6d1de14"><td class="mdescLeft"> </td><td class="mdescRight">Type of callback used to request send the serialised <b>ADVERTISE</b> message. <br /></td></tr>
<tr class="separator:a574d84b0a91a0f9b4cc7b814c6d1de14"><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:a19a4d5afa2faa5b9d6785ab7b58edb42" id="r_a19a4d5afa2faa5b9d6785ab7b58edb42"><td class="memItemLeft" align="right" valign="top"><a id="a19a4d5afa2faa5b9d6785ab7b58edb42" name="a19a4d5afa2faa5b9d6785ab7b58edb42"></a>
 </td><td class="memItemRight" valign="bottom"><b>Gateway</b> ()</td></tr>
<tr class="memdesc:a19a4d5afa2faa5b9d6785ab7b58edb42"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a19a4d5afa2faa5b9d6785ab7b58edb42"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb426c1dcbd1eb7d59a45b3bf8cf315e" id="r_abb426c1dcbd1eb7d59a45b3bf8cf315e"><td class="memItemLeft" align="right" valign="top"><a id="abb426c1dcbd1eb7d59a45b3bf8cf315e" name="abb426c1dcbd1eb7d59a45b3bf8cf315e"></a>
 </td><td class="memItemRight" valign="bottom"><b>~Gateway</b> ()</td></tr>
<tr class="memdesc:abb426c1dcbd1eb7d59a45b3bf8cf315e"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:abb426c1dcbd1eb7d59a45b3bf8cf315e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00e7d543ec8b9f1c7e356e7ec56f3ea8" id="r_a00e7d543ec8b9f1c7e356e7ec56f3ea8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html#a00e7d543ec8b9f1c7e356e7ec56f3ea8">setNextTickProgramReqCb</a> (<a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html#a8a6c83ec82aa22f872b29f4d79d5713f">NextTickProgramReqCb</a> &&func)</td></tr>
<tr class="memdesc:a00e7d543ec8b9f1c7e356e7ec56f3ea8"><td class="mdescLeft"> </td><td class="mdescRight">Set the callback to be invoked when new time measurement is required. <br /></td></tr>
<tr class="separator:a00e7d543ec8b9f1c7e356e7ec56f3ea8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abce790ddf300647f8ff52bfc84385727" id="r_abce790ddf300647f8ff52bfc84385727"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html#abce790ddf300647f8ff52bfc84385727">setSendDataReqCb</a> (<a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html#a574d84b0a91a0f9b4cc7b814c6d1de14">SendDataReqCb</a> &&func)</td></tr>
<tr class="memdesc:abce790ddf300647f8ff52bfc84385727"><td class="mdescLeft"> </td><td class="mdescRight">Set the callback to be invoked when new <b>ADVERTISE</b> message needs to be broadcasted. <br /></td></tr>
<tr class="separator:abce790ddf300647f8ff52bfc84385727"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adb1827fad98031ab79d73bbc8ff08117" id="r_adb1827fad98031ab79d73bbc8ff08117"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html#adb1827fad98031ab79d73bbc8ff08117">setAdvertisePeriod</a> (std::uint16_t value)</td></tr>
<tr class="memdesc:adb1827fad98031ab79d73bbc8ff08117"><td class="mdescLeft"> </td><td class="mdescRight">Set period after which <b>ADVERTISE</b> message needs to be constatly sent. <br /></td></tr>
<tr class="separator:adb1827fad98031ab79d73bbc8ff08117"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af5b510419a496c8a150e3747f94edc79" id="r_af5b510419a496c8a150e3747f94edc79"><td class="memItemLeft" align="right" valign="top"><a id="af5b510419a496c8a150e3747f94edc79" name="af5b510419a496c8a150e3747f94edc79"></a>
std::uint16_t </td><td class="memItemRight" valign="bottom"><b>getAdvertisePeriod</b> () const</td></tr>
<tr class="memdesc:af5b510419a496c8a150e3747f94edc79"><td class="mdescLeft"> </td><td class="mdescRight">Get current configuration of the <b>ADVERTISE</b> message period. <br /></td></tr>
<tr class="separator:af5b510419a496c8a150e3747f94edc79"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae3340303dabcfd03dbb98b6a9dd68f04" id="r_ae3340303dabcfd03dbb98b6a9dd68f04"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html#ae3340303dabcfd03dbb98b6a9dd68f04">setGatewayId</a> (std::uint8_t value)</td></tr>
<tr class="memdesc:ae3340303dabcfd03dbb98b6a9dd68f04"><td class="mdescLeft"> </td><td class="mdescRight">Set gateway numeric ID to be advertised. <br /></td></tr>
<tr class="separator:ae3340303dabcfd03dbb98b6a9dd68f04"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ade220efe4c94dda44a5e3db214825382" id="r_ade220efe4c94dda44a5e3db214825382"><td class="memItemLeft" align="right" valign="top"><a id="ade220efe4c94dda44a5e3db214825382" name="ade220efe4c94dda44a5e3db214825382"></a>
std::uint8_t </td><td class="memItemRight" valign="bottom"><b>getGatewayId</b> () const</td></tr>
<tr class="memdesc:ade220efe4c94dda44a5e3db214825382"><td class="mdescLeft"> </td><td class="mdescRight">Get current gateway numeric ID configuration. <br /></td></tr>
<tr class="separator:ade220efe4c94dda44a5e3db214825382"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a12ea0af2a2065e6c311bd74aaebd4489" id="r_a12ea0af2a2065e6c311bd74aaebd4489"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html#a12ea0af2a2065e6c311bd74aaebd4489">start</a> ()</td></tr>
<tr class="memdesc:a12ea0af2a2065e6c311bd74aaebd4489"><td class="mdescLeft"> </td><td class="mdescRight">Start the operation of the object. <br /></td></tr>
<tr class="separator:a12ea0af2a2065e6c311bd74aaebd4489"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a08c3c68c6928afebd06c5dd045571366" id="r_a08c3c68c6928afebd06c5dd045571366"><td class="memItemLeft" align="right" valign="top"><a id="a08c3c68c6928afebd06c5dd045571366" name="a08c3c68c6928afebd06c5dd045571366"></a>
void </td><td class="memItemRight" valign="bottom"><b>stop</b> ()</td></tr>
<tr class="memdesc:a08c3c68c6928afebd06c5dd045571366"><td class="mdescLeft"> </td><td class="mdescRight">Stop the operation of the object. <br /></td></tr>
<tr class="separator:a08c3c68c6928afebd06c5dd045571366"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a656234af2ad8d324f0d3e2595c6826fd" id="r_a656234af2ad8d324f0d3e2595c6826fd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html#a656234af2ad8d324f0d3e2595c6826fd">tick</a> ()</td></tr>
<tr class="memdesc:a656234af2ad8d324f0d3e2595c6826fd"><td class="mdescLeft"> </td><td class="mdescRight">Notify the <a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html">Gateway</a> object about requested time period expiry. <br /></td></tr>
<tr class="separator:a656234af2ad8d324f0d3e2595c6826fd"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a8a6c83ec82aa22f872b29f4d79d5713f" name="a8a6c83ec82aa22f872b29f4d79d5713f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a6c83ec82aa22f872b29f4d79d5713f">◆ </a></span>NextTickProgramReqCb</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html#a8a6c83ec82aa22f872b29f4d79d5713f">cc_mqttsn_gateway::Gateway::NextTickProgramReqCb</a> = std::function<void (unsigned ms)></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of the callback used to request time measurement. </p>
<p>The driving code is expected to invoke <a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html#a656234af2ad8d324f0d3e2595c6826fd" title="Notify the Gateway object about requested time period expiry.">tick()</a> member function when the requested time expires. The callback is set using <a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html#a00e7d543ec8b9f1c7e356e7ec56f3ea8" title="Set the callback to be invoked when new time measurement is required.">setNextTickProgramReqCb()</a> member function. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ms</td><td>Number of <b>milliseconds</b> to measure. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a574d84b0a91a0f9b4cc7b814c6d1de14" name="a574d84b0a91a0f9b4cc7b814c6d1de14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a574d84b0a91a0f9b4cc7b814c6d1de14">◆ </a></span>SendDataReqCb</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html#a574d84b0a91a0f9b4cc7b814c6d1de14">cc_mqttsn_gateway::Gateway::SendDataReqCb</a> = std::function<void (const std::uint8_t* buf, std::size_t bufSize)></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of callback used to request send the serialised <b>ADVERTISE</b> message. </p>
<p>According to MQTT-SN protocol, the <b>ADVERTISE</b> message needs to be <b>broadcasted</b>. The driving code is responsible to broadcast the requested message to all possible clients on the network. The callback is set using <a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html#abce790ddf300647f8ff52bfc84385727" title="Set the callback to be invoked when new ADVERTISE message needs to be broadcasted.">setSendDataReqCb()</a> member function.</p>
<p>The buffer containing serialised <b>ADVERTISE</b> message belongs to the internal data structures of the <a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html">Gateway</a>, and may be tampered with when the callback function returns. The driving code may be required to copy contents of the buffer to its internal data structures and preserve it until send over I/O link operation is complete. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to buffer containing serialised <b>ADVERTISE</b> message. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">bufSize</td><td>Number of bytes in the buffer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="adb1827fad98031ab79d73bbc8ff08117" name="adb1827fad98031ab79d73bbc8ff08117"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb1827fad98031ab79d73bbc8ff08117">◆ </a></span>setAdvertisePeriod()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cc_mqttsn_gateway::Gateway::setAdvertisePeriod </td>
<td>(</td>
<td class="paramtype">std::uint16_t </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set period after which <b>ADVERTISE</b> message needs to be constatly sent. </p>
<p>The value must be greater than 0. If the value is not set, the object can not be started (see <a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html#a12ea0af2a2065e6c311bd74aaebd4489" title="Start the operation of the object.">start()</a>). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Advertise period in <b>seconds</b>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae3340303dabcfd03dbb98b6a9dd68f04" name="ae3340303dabcfd03dbb98b6a9dd68f04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3340303dabcfd03dbb98b6a9dd68f04">◆ </a></span>setGatewayId()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cc_mqttsn_gateway::Gateway::setGatewayId </td>
<td>(</td>
<td class="paramtype">std::uint8_t </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set gateway numeric ID to be advertised. </p>
<p>If not set, default value 0 is assumed. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td><a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html" title="Interface for Gateway entity.">Gateway</a> numeric ID. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a00e7d543ec8b9f1c7e356e7ec56f3ea8" name="a00e7d543ec8b9f1c7e356e7ec56f3ea8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00e7d543ec8b9f1c7e356e7ec56f3ea8">◆ </a></span>setNextTickProgramReqCb()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cc_mqttsn_gateway::Gateway::setNextTickProgramReqCb </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html#a8a6c83ec82aa22f872b29f4d79d5713f">NextTickProgramReqCb</a> && </td>
<td class="paramname"><em>func</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the callback to be invoked when new time measurement is required. </p>
<p>This is a must have callback, without it the object can not be started (see <a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html#a12ea0af2a2065e6c311bd74aaebd4489" title="Start the operation of the object.">start()</a>). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>R-value reference to the callback object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="abce790ddf300647f8ff52bfc84385727" name="abce790ddf300647f8ff52bfc84385727"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abce790ddf300647f8ff52bfc84385727">◆ </a></span>setSendDataReqCb()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cc_mqttsn_gateway::Gateway::setSendDataReqCb </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html#a574d84b0a91a0f9b4cc7b814c6d1de14">SendDataReqCb</a> && </td>
<td class="paramname"><em>func</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the callback to be invoked when new <b>ADVERTISE</b> message needs to be broadcasted. </p>
<p>This is a must have callback, without it the object can not be started (see <a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html#a12ea0af2a2065e6c311bd74aaebd4489" title="Start the operation of the object.">start()</a>). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>R-value reference to the callback object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a12ea0af2a2065e6c311bd74aaebd4489" name="a12ea0af2a2065e6c311bd74aaebd4489"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12ea0af2a2065e6c311bd74aaebd4489">◆ </a></span>start()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool cc_mqttsn_gateway::Gateway::start </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start the operation of the object. </p>
<p>The function will check whether all callbacks as well as advertise period have been properly set. It will also immediately request to send the serialised <b>ADVERTISE</b> message and to re-program the timer for the <a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html#a656234af2ad8d324f0d3e2595c6826fd" title="Notify the Gateway object about requested time period expiry.">tick()</a> after set advertise period. </p>
</div>
</div>
<a id="a656234af2ad8d324f0d3e2595c6826fd" name="a656234af2ad8d324f0d3e2595c6826fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a656234af2ad8d324f0d3e2595c6826fd">◆ </a></span>tick()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cc_mqttsn_gateway::Gateway::tick </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Notify the <a class="el" href="classcc__mqttsn__gateway_1_1Gateway.html">Gateway</a> object about requested time period expiry. </p>
<p>This function needs to be called from the driving code after the requested time measurement has expired. The call will cause invocation of send data request callback as well as new time measurement request callback. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/cc_mqttsn_gateway/<a class="el" href="Gateway_8h_source.html">Gateway.h</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.8
</small></address>
</body>
</html>