-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclasscc__mqttsn__gateway_1_1Session.html
1191 lines (1078 loc) · 80.4 KB
/
classcc__mqttsn__gateway_1_1Session.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
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!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::Session 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_1Session.html">Session</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_1Session-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">cc_mqttsn_gateway::Session 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_1Session.html" title="Interface for Session entity.">Session</a></b> entity. </p>
<p>The responsibility of the <b><a class="el" href="classcc__mqttsn__gateway_1_1Session.html" title="Interface for Session entity.">Session</a></b> object is to manage and forward traffic of messages between single MQTT-SN client and broker. </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:a8708e95121d9ddbfec36c7173a4fb1dd" id="r_a8708e95121d9ddbfec36c7173a4fb1dd"><td class="memItemLeft" align="right" valign="top"><a id="a8708e95121d9ddbfec36c7173a4fb1dd" name="a8708e95121d9ddbfec36c7173a4fb1dd"></a>
using </td><td class="memItemRight" valign="bottom"><b>BinaryData</b> = std::vector< std::uint8_t ></td></tr>
<tr class="memdesc:a8708e95121d9ddbfec36c7173a4fb1dd"><td class="mdescLeft"> </td><td class="mdescRight">Type for buffer of binary data. <br /></td></tr>
<tr class="separator:a8708e95121d9ddbfec36c7173a4fb1dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18ce4af1ec9bd9368cdbe082537cac6e" id="r_a18ce4af1ec9bd9368cdbe082537cac6e"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a18ce4af1ec9bd9368cdbe082537cac6e">AuthInfo</a> = std::pair< std::string, <a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a8708e95121d9ddbfec36c7173a4fb1dd">BinaryData</a> ></td></tr>
<tr class="memdesc:a18ce4af1ec9bd9368cdbe082537cac6e"><td class="mdescLeft"> </td><td class="mdescRight">Type of authentication information. <br /></td></tr>
<tr class="separator:a18ce4af1ec9bd9368cdbe082537cac6e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4d3c1b6e8a7f34189f976958e72773c0" id="r_a4d3c1b6e8a7f34189f976958e72773c0"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a4d3c1b6e8a7f34189f976958e72773c0">NextTickProgramReqCb</a> = std::function< void(unsigned value)></td></tr>
<tr class="memdesc:a4d3c1b6e8a7f34189f976958e72773c0"><td class="mdescLeft"> </td><td class="mdescRight">Type of callback, used to request new time measurement. <br /></td></tr>
<tr class="separator:a4d3c1b6e8a7f34189f976958e72773c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b4ce5a131367e564c4cb629585e92b3" id="r_a4b4ce5a131367e564c4cb629585e92b3"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a4b4ce5a131367e564c4cb629585e92b3">CancelTickWaitReqCb</a> = std::function< unsigned()></td></tr>
<tr class="memdesc:a4b4ce5a131367e564c4cb629585e92b3"><td class="mdescLeft"> </td><td class="mdescRight">Type of callback, used to cancel existing time measurement. <br /></td></tr>
<tr class="separator:a4b4ce5a131367e564c4cb629585e92b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a91cde78d651a8139fbe8a6cc03809023" id="r_a91cde78d651a8139fbe8a6cc03809023"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a91cde78d651a8139fbe8a6cc03809023">ClientSendDataReqCb</a> = std::function< void(const std::uint8_t *buf, std::size_t bufSize, unsigned broadcastRadius)></td></tr>
<tr class="memdesc:a91cde78d651a8139fbe8a6cc03809023"><td class="mdescLeft"> </td><td class="mdescRight">Type of callback, used to request delivery of serialised message to the client. <br /></td></tr>
<tr class="separator:a91cde78d651a8139fbe8a6cc03809023"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ade8a6df2b5852e200b70ca031e0446aa" id="r_ade8a6df2b5852e200b70ca031e0446aa"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#ade8a6df2b5852e200b70ca031e0446aa">BrokerSendDataReqCb</a> = std::function< void(const std::uint8_t *buf, std::size_t bufSize)></td></tr>
<tr class="memdesc:ade8a6df2b5852e200b70ca031e0446aa"><td class="mdescLeft"> </td><td class="mdescRight">Type of callback, used to request delivery of serialised message to the broker. <br /></td></tr>
<tr class="separator:ade8a6df2b5852e200b70ca031e0446aa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a61bf51eecaa90806ce08c821be078b0a" id="r_a61bf51eecaa90806ce08c821be078b0a"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a61bf51eecaa90806ce08c821be078b0a">TerminationReqCb</a> = std::function< void()></td></tr>
<tr class="memdesc:a61bf51eecaa90806ce08c821be078b0a"><td class="mdescLeft"> </td><td class="mdescRight">Type of callback, used to request session termination. <br /></td></tr>
<tr class="separator:a61bf51eecaa90806ce08c821be078b0a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a13c1eae248902824f4871d1680e7c6e4" id="r_a13c1eae248902824f4871d1680e7c6e4"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a13c1eae248902824f4871d1680e7c6e4">BrokerReconnectReqCb</a> = std::function< void()></td></tr>
<tr class="memdesc:a13c1eae248902824f4871d1680e7c6e4"><td class="mdescLeft"> </td><td class="mdescRight">Type of callback used to request reconnection to the broker. <br /></td></tr>
<tr class="separator:a13c1eae248902824f4871d1680e7c6e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afae491947b50b43e3b136a727d9374f2" id="r_afae491947b50b43e3b136a727d9374f2"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#afae491947b50b43e3b136a727d9374f2">ClientConnectedReportCb</a> = std::function< void(const std::string &clientId)></td></tr>
<tr class="memdesc:afae491947b50b43e3b136a727d9374f2"><td class="mdescLeft"> </td><td class="mdescRight">Type of callback used to report client ID of the newly connected MQTT-SN client. <br /></td></tr>
<tr class="separator:afae491947b50b43e3b136a727d9374f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af1ef7fa091dd09f74b5504f4f21fa6ef" id="r_af1ef7fa091dd09f74b5504f4f21fa6ef"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#af1ef7fa091dd09f74b5504f4f21fa6ef">AuthInfoReqCb</a> = std::function< <a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a18ce4af1ec9bd9368cdbe082537cac6e">AuthInfo</a>(const std::string &clientId)></td></tr>
<tr class="memdesc:af1ef7fa091dd09f74b5504f4f21fa6ef"><td class="mdescLeft"> </td><td class="mdescRight">Type of callback used to request authentication information of the client that is trying connect. <br /></td></tr>
<tr class="separator:af1ef7fa091dd09f74b5504f4f21fa6ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4a6e644c040bb2f3bd16fab845f61fc2" id="r_a4a6e644c040bb2f3bd16fab845f61fc2"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a4a6e644c040bb2f3bd16fab845f61fc2">ErrorReportCb</a> = std::function< void(const char *msg)></td></tr>
<tr class="memdesc:a4a6e644c040bb2f3bd16fab845f61fc2"><td class="mdescLeft"> </td><td class="mdescRight">Type of the callback used to report detected errors. <br /></td></tr>
<tr class="separator:a4a6e644c040bb2f3bd16fab845f61fc2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7f3eeb173021e2bebd5edbbcb4e58c7d" id="r_a7f3eeb173021e2bebd5edbbcb4e58c7d"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a7f3eeb173021e2bebd5edbbcb4e58c7d">FwdEncSessionCreatedReportCb</a> = std::function< bool(<a class="el" href="classcc__mqttsn__gateway_1_1Session.html">Session</a> *session)></td></tr>
<tr class="memdesc:a7f3eeb173021e2bebd5edbbcb4e58c7d"><td class="mdescLeft"> </td><td class="mdescRight">Type of callback used to notify the application about forwarding encapsulation session being created. <br /></td></tr>
<tr class="separator:a7f3eeb173021e2bebd5edbbcb4e58c7d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad75b3f3fbb8d555302375a2ae25b82e2" id="r_ad75b3f3fbb8d555302375a2ae25b82e2"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#ad75b3f3fbb8d555302375a2ae25b82e2">FwdEncSessionDeletedReportCb</a> = std::function< void(<a class="el" href="classcc__mqttsn__gateway_1_1Session.html">Session</a> *session)></td></tr>
<tr class="memdesc:ad75b3f3fbb8d555302375a2ae25b82e2"><td class="mdescLeft"> </td><td class="mdescRight">Type of callback used to notify the application about forwarding encapsulation session being deleted. <br /></td></tr>
<tr class="separator:ad75b3f3fbb8d555302375a2ae25b82e2"><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:a0f2bce948b600f2dbdba12834b3fdabb" id="r_a0f2bce948b600f2dbdba12834b3fdabb"><td class="memItemLeft" align="right" valign="top"><a id="a0f2bce948b600f2dbdba12834b3fdabb" name="a0f2bce948b600f2dbdba12834b3fdabb"></a>
 </td><td class="memItemRight" valign="bottom"><b>Session</b> ()</td></tr>
<tr class="memdesc:a0f2bce948b600f2dbdba12834b3fdabb"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a0f2bce948b600f2dbdba12834b3fdabb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2be3a985fad6e8673acfe5103fd0a39b" id="r_a2be3a985fad6e8673acfe5103fd0a39b"><td class="memItemLeft" align="right" valign="top"><a id="a2be3a985fad6e8673acfe5103fd0a39b" name="a2be3a985fad6e8673acfe5103fd0a39b"></a>
 </td><td class="memItemRight" valign="bottom"><b>~Session</b> ()</td></tr>
<tr class="memdesc:a2be3a985fad6e8673acfe5103fd0a39b"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a2be3a985fad6e8673acfe5103fd0a39b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad03abf3c8beaad947016bea6a5e66d85" id="r_ad03abf3c8beaad947016bea6a5e66d85"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#ad03abf3c8beaad947016bea6a5e66d85">setNextTickProgramReqCb</a> (<a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a4d3c1b6e8a7f34189f976958e72773c0">NextTickProgramReqCb</a> &&func)</td></tr>
<tr class="memdesc:ad03abf3c8beaad947016bea6a5e66d85"><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:ad03abf3c8beaad947016bea6a5e66d85"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5219a534cc2f71375f1bba76e3819695" id="r_a5219a534cc2f71375f1bba76e3819695"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a5219a534cc2f71375f1bba76e3819695">setCancelTickWaitReqCb</a> (<a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a4b4ce5a131367e564c4cb629585e92b3">CancelTickWaitReqCb</a> &&func)</td></tr>
<tr class="memdesc:a5219a534cc2f71375f1bba76e3819695"><td class="mdescLeft"> </td><td class="mdescRight">Set the callback to be invoked when previously requested time measurement needs to be cancelled. <br /></td></tr>
<tr class="separator:a5219a534cc2f71375f1bba76e3819695"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb4228612f45bc52de3d62be40f28c29" id="r_abb4228612f45bc52de3d62be40f28c29"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#abb4228612f45bc52de3d62be40f28c29">setSendDataClientReqCb</a> (<a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a91cde78d651a8139fbe8a6cc03809023">ClientSendDataReqCb</a> &&func)</td></tr>
<tr class="memdesc:abb4228612f45bc52de3d62be40f28c29"><td class="mdescLeft"> </td><td class="mdescRight">Set the callback to be invoked when new data needs to be sent to the client. <br /></td></tr>
<tr class="separator:abb4228612f45bc52de3d62be40f28c29"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a230c8f69e352f9314286990f5d0979f4" id="r_a230c8f69e352f9314286990f5d0979f4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a230c8f69e352f9314286990f5d0979f4">setSendDataBrokerReqCb</a> (<a class="el" href="classcc__mqttsn__gateway_1_1Session.html#ade8a6df2b5852e200b70ca031e0446aa">BrokerSendDataReqCb</a> &&func)</td></tr>
<tr class="memdesc:a230c8f69e352f9314286990f5d0979f4"><td class="mdescLeft"> </td><td class="mdescRight">Set the callback to be invoked when new data needs to be sent to the broker. <br /></td></tr>
<tr class="separator:a230c8f69e352f9314286990f5d0979f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7325fc0c10dc1cae59a6ff9a2252e7ee" id="r_a7325fc0c10dc1cae59a6ff9a2252e7ee"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a7325fc0c10dc1cae59a6ff9a2252e7ee">setTerminationReqCb</a> (<a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a61bf51eecaa90806ce08c821be078b0a">TerminationReqCb</a> &&func)</td></tr>
<tr class="memdesc:a7325fc0c10dc1cae59a6ff9a2252e7ee"><td class="mdescLeft"> </td><td class="mdescRight">Set the callback to be invoked when the session needs to be terminated and this <a class="el" href="classcc__mqttsn__gateway_1_1Session.html">Session</a> object deleted. <br /></td></tr>
<tr class="separator:a7325fc0c10dc1cae59a6ff9a2252e7ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2db095effa29cff1497342e4e0d638ac" id="r_a2db095effa29cff1497342e4e0d638ac"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a2db095effa29cff1497342e4e0d638ac">setBrokerReconnectReqCb</a> (<a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a13c1eae248902824f4871d1680e7c6e4">BrokerReconnectReqCb</a> &&func)</td></tr>
<tr class="memdesc:a2db095effa29cff1497342e4e0d638ac"><td class="mdescLeft"> </td><td class="mdescRight">Set the callback to be invoked when the session needs to close existing TCP/IP connection to the broker and open a new one. <br /></td></tr>
<tr class="separator:a2db095effa29cff1497342e4e0d638ac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa78b22f6b7144f598639160703376292" id="r_aa78b22f6b7144f598639160703376292"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#aa78b22f6b7144f598639160703376292">setClientConnectedReportCb</a> (<a class="el" href="classcc__mqttsn__gateway_1_1Session.html#afae491947b50b43e3b136a727d9374f2">ClientConnectedReportCb</a> &&func)</td></tr>
<tr class="memdesc:aa78b22f6b7144f598639160703376292"><td class="mdescLeft"> </td><td class="mdescRight">Set the callback to be invoked when MQTT-SN client is successfully connected to the broker. <br /></td></tr>
<tr class="separator:aa78b22f6b7144f598639160703376292"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab519faa29c6d2386e2b305fdb2289bbf" id="r_ab519faa29c6d2386e2b305fdb2289bbf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#ab519faa29c6d2386e2b305fdb2289bbf">setAuthInfoReqCb</a> (<a class="el" href="classcc__mqttsn__gateway_1_1Session.html#af1ef7fa091dd09f74b5504f4f21fa6ef">AuthInfoReqCb</a> &&func)</td></tr>
<tr class="memdesc:ab519faa29c6d2386e2b305fdb2289bbf"><td class="mdescLeft"> </td><td class="mdescRight">Set the callback to be used to request authentication information for specific client. <br /></td></tr>
<tr class="separator:ab519faa29c6d2386e2b305fdb2289bbf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a63ad6bad2e911a882b42fda99a827c70" id="r_a63ad6bad2e911a882b42fda99a827c70"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a63ad6bad2e911a882b42fda99a827c70">setErrorReportCb</a> (<a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a4a6e644c040bb2f3bd16fab845f61fc2">ErrorReportCb</a> &&func)</td></tr>
<tr class="memdesc:a63ad6bad2e911a882b42fda99a827c70"><td class="mdescLeft"> </td><td class="mdescRight">Set the callback to be used to report detected errors. <br /></td></tr>
<tr class="separator:a63ad6bad2e911a882b42fda99a827c70"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aca05f624d53ec51fb6b2db201b2dfd19" id="r_aca05f624d53ec51fb6b2db201b2dfd19"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#aca05f624d53ec51fb6b2db201b2dfd19">setFwdEncSessionCreatedReportCb</a> (<a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a7f3eeb173021e2bebd5edbbcb4e58c7d">FwdEncSessionCreatedReportCb</a> &&func)</td></tr>
<tr class="memdesc:aca05f624d53ec51fb6b2db201b2dfd19"><td class="mdescLeft"> </td><td class="mdescRight">Set the callback to be invoked when the forwarding encapsulation session is detected and to notify application about such session creation. <br /></td></tr>
<tr class="separator:aca05f624d53ec51fb6b2db201b2dfd19"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a748fdd26e5639d274e4f28d2f3c2fe56" id="r_a748fdd26e5639d274e4f28d2f3c2fe56"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a748fdd26e5639d274e4f28d2f3c2fe56">setFwdEncSessionDeletedReportCb</a> (<a class="el" href="classcc__mqttsn__gateway_1_1Session.html#ad75b3f3fbb8d555302375a2ae25b82e2">FwdEncSessionDeletedReportCb</a> &&func)</td></tr>
<tr class="memdesc:a748fdd26e5639d274e4f28d2f3c2fe56"><td class="mdescLeft"> </td><td class="mdescRight">Set the callback to be invoked when the forwarding encapsulation session is about to be deleted. <br /></td></tr>
<tr class="separator:a748fdd26e5639d274e4f28d2f3c2fe56"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6120e5c84cfa3e7a577c28ce5351cd2f" id="r_a6120e5c84cfa3e7a577c28ce5351cd2f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a6120e5c84cfa3e7a577c28ce5351cd2f">setGatewayId</a> (std::uint8_t value)</td></tr>
<tr class="memdesc:a6120e5c84cfa3e7a577c28ce5351cd2f"><td class="mdescLeft"> </td><td class="mdescRight">Set gateway numeric ID to be reported when requested. <br /></td></tr>
<tr class="separator:a6120e5c84cfa3e7a577c28ce5351cd2f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a851aeead4cbdc80dedcc7d90ff13b517" id="r_a851aeead4cbdc80dedcc7d90ff13b517"><td class="memItemLeft" align="right" valign="top"><a id="a851aeead4cbdc80dedcc7d90ff13b517" name="a851aeead4cbdc80dedcc7d90ff13b517"></a>
std::uint8_t </td><td class="memItemRight" valign="bottom"><b>getGatewayId</b> () const</td></tr>
<tr class="memdesc:a851aeead4cbdc80dedcc7d90ff13b517"><td class="mdescLeft"> </td><td class="mdescRight">Get configured gateway numeric ID to be reported when requested. <br /></td></tr>
<tr class="separator:a851aeead4cbdc80dedcc7d90ff13b517"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4159f98133b10a30982ee6c54e7c9be6" id="r_a4159f98133b10a30982ee6c54e7c9be6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a4159f98133b10a30982ee6c54e7c9be6">setRetryPeriod</a> (unsigned value)</td></tr>
<tr class="memdesc:a4159f98133b10a30982ee6c54e7c9be6"><td class="mdescLeft"> </td><td class="mdescRight">Set retry period to wait between resending unacknowledged message to the client and/or broker. <br /></td></tr>
<tr class="separator:a4159f98133b10a30982ee6c54e7c9be6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a33f45dbe488afe79d8e06f430440a578" id="r_a33f45dbe488afe79d8e06f430440a578"><td class="memItemLeft" align="right" valign="top"><a id="a33f45dbe488afe79d8e06f430440a578" name="a33f45dbe488afe79d8e06f430440a578"></a>
unsigned </td><td class="memItemRight" valign="bottom"><b>getRetryPeriod</b> () const</td></tr>
<tr class="memdesc:a33f45dbe488afe79d8e06f430440a578"><td class="mdescLeft"> </td><td class="mdescRight">Get the current configuration of the retry period. <br /></td></tr>
<tr class="separator:a33f45dbe488afe79d8e06f430440a578"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a65eea77d5c98b46c5ac12053976b0771" id="r_a65eea77d5c98b46c5ac12053976b0771"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a65eea77d5c98b46c5ac12053976b0771">setRetryCount</a> (unsigned value)</td></tr>
<tr class="memdesc:a65eea77d5c98b46c5ac12053976b0771"><td class="mdescLeft"> </td><td class="mdescRight">Set number of retry attempts to perform before abandoning attempt to send unacknowledged message. <br /></td></tr>
<tr class="separator:a65eea77d5c98b46c5ac12053976b0771"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aed998167b253db7a980f88d124f3fbc7" id="r_aed998167b253db7a980f88d124f3fbc7"><td class="memItemLeft" align="right" valign="top"><a id="aed998167b253db7a980f88d124f3fbc7" name="aed998167b253db7a980f88d124f3fbc7"></a>
unsigned </td><td class="memItemRight" valign="bottom"><b>getRetryCount</b> () const</td></tr>
<tr class="memdesc:aed998167b253db7a980f88d124f3fbc7"><td class="mdescLeft"> </td><td class="mdescRight">Get the current configuration of the retry count. <br /></td></tr>
<tr class="separator:aed998167b253db7a980f88d124f3fbc7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b96e11b66b6ece04f8a331c9b72600c" id="r_a0b96e11b66b6ece04f8a331c9b72600c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a0b96e11b66b6ece04f8a331c9b72600c">setSleepingClientMsgLimit</a> (std::size_t value)</td></tr>
<tr class="memdesc:a0b96e11b66b6ece04f8a331c9b72600c"><td class="mdescLeft"> </td><td class="mdescRight">Provide limit to number pending messages being accumulated for the sleeping client. <br /></td></tr>
<tr class="separator:a0b96e11b66b6ece04f8a331c9b72600c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0160ae049acb4d1d60feed15bc09b921" id="r_a0160ae049acb4d1d60feed15bc09b921"><td class="memItemLeft" align="right" valign="top"><a id="a0160ae049acb4d1d60feed15bc09b921" name="a0160ae049acb4d1d60feed15bc09b921"></a>
std::size_t </td><td class="memItemRight" valign="bottom"><b>getSleepingClientMsgLimit</b> () const</td></tr>
<tr class="memdesc:a0160ae049acb4d1d60feed15bc09b921"><td class="mdescLeft"> </td><td class="mdescRight">Get currenly configured limit to pending messages being accumulated for the sleeping client. <br /></td></tr>
<tr class="separator:a0160ae049acb4d1d60feed15bc09b921"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a31a9ce1bc29973c0659044f752ff3d14" id="r_a31a9ce1bc29973c0659044f752ff3d14"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a31a9ce1bc29973c0659044f752ff3d14">setDefaultClientId</a> (const std::string &value)</td></tr>
<tr class="memdesc:a31a9ce1bc29973c0659044f752ff3d14"><td class="mdescLeft"> </td><td class="mdescRight">Provide default client ID for clients that report empty one in their attempt to connect. <br /></td></tr>
<tr class="separator:a31a9ce1bc29973c0659044f752ff3d14"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a361a7c0c1871010437ac0877eba43242" id="r_a361a7c0c1871010437ac0877eba43242"><td class="memItemLeft" align="right" valign="top"><a id="a361a7c0c1871010437ac0877eba43242" name="a361a7c0c1871010437ac0877eba43242"></a>
const std::string & </td><td class="memItemRight" valign="bottom"><b>getDefaultClientId</b> () const</td></tr>
<tr class="memdesc:a361a7c0c1871010437ac0877eba43242"><td class="mdescLeft"> </td><td class="mdescRight">Get current default client id configuration. <br /></td></tr>
<tr class="separator:a361a7c0c1871010437ac0877eba43242"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad9933a5769200858d7faa2bf1f374d82" id="r_ad9933a5769200858d7faa2bf1f374d82"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#ad9933a5769200858d7faa2bf1f374d82">setPubOnlyKeepAlive</a> (std::uint16_t value)</td></tr>
<tr class="memdesc:ad9933a5769200858d7faa2bf1f374d82"><td class="mdescLeft"> </td><td class="mdescRight">Provide default "keep alive" period for "publish only" clients, that do not make an attempt to connect to the gateway. <br /></td></tr>
<tr class="separator:ad9933a5769200858d7faa2bf1f374d82"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f4c3c29fb9238733200686d039552da" id="r_a4f4c3c29fb9238733200686d039552da"><td class="memItemLeft" align="right" valign="top"><a id="a4f4c3c29fb9238733200686d039552da" name="a4f4c3c29fb9238733200686d039552da"></a>
std::uint16_t </td><td class="memItemRight" valign="bottom"><b>getPubOnlyKeepAlive</b> () const</td></tr>
<tr class="memdesc:a4f4c3c29fb9238733200686d039552da"><td class="mdescLeft"> </td><td class="mdescRight">Get current configuration of the default "keep alive" period for "publish only" clients. <br /></td></tr>
<tr class="separator:a4f4c3c29fb9238733200686d039552da"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a12513af6a5f2db6ebc57947771379bca" id="r_a12513af6a5f2db6ebc57947771379bca"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a12513af6a5f2db6ebc57947771379bca">start</a> ()</td></tr>
<tr class="memdesc:a12513af6a5f2db6ebc57947771379bca"><td class="mdescLeft"> </td><td class="mdescRight">Start this object's operation. <br /></td></tr>
<tr class="separator:a12513af6a5f2db6ebc57947771379bca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae4a65f7acc2a8af7170daccc35278de5" id="r_ae4a65f7acc2a8af7170daccc35278de5"><td class="memItemLeft" align="right" valign="top"><a id="ae4a65f7acc2a8af7170daccc35278de5" name="ae4a65f7acc2a8af7170daccc35278de5"></a>
void </td><td class="memItemRight" valign="bottom"><b>stop</b> ()</td></tr>
<tr class="memdesc:ae4a65f7acc2a8af7170daccc35278de5"><td class="mdescLeft"> </td><td class="mdescRight">Stop the operation of the object. <br /></td></tr>
<tr class="separator:ae4a65f7acc2a8af7170daccc35278de5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac4074b355f723b9cf16c7df90dca2b6e" id="r_ac4074b355f723b9cf16c7df90dca2b6e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#ac4074b355f723b9cf16c7df90dca2b6e">isRunning</a> () const</td></tr>
<tr class="memdesc:ac4074b355f723b9cf16c7df90dca2b6e"><td class="mdescLeft"> </td><td class="mdescRight">Check whether the object's operation has been successfull started. <br /></td></tr>
<tr class="separator:ac4074b355f723b9cf16c7df90dca2b6e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3d3c252c3b9aa9572d2f8f52a4fee3a6" id="r_a3d3c252c3b9aa9572d2f8f52a4fee3a6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a3d3c252c3b9aa9572d2f8f52a4fee3a6">tick</a> ()</td></tr>
<tr class="memdesc:a3d3c252c3b9aa9572d2f8f52a4fee3a6"><td class="mdescLeft"> </td><td class="mdescRight">Notify the <a class="el" href="classcc__mqttsn__gateway_1_1Session.html">Session</a> object about requested time period expiry. <br /></td></tr>
<tr class="separator:a3d3c252c3b9aa9572d2f8f52a4fee3a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3ef4bfb2e5c6d6768ba1b9ef75e82f93" id="r_a3ef4bfb2e5c6d6768ba1b9ef75e82f93"><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a3ef4bfb2e5c6d6768ba1b9ef75e82f93">dataFromClient</a> (const std::uint8_t *buf, std::size_t len)</td></tr>
<tr class="memdesc:a3ef4bfb2e5c6d6768ba1b9ef75e82f93"><td class="mdescLeft"> </td><td class="mdescRight">Provide data received from the client for processing. <br /></td></tr>
<tr class="separator:a3ef4bfb2e5c6d6768ba1b9ef75e82f93"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a728ac52d1c104c446c5c4b059d16d9e1" id="r_a728ac52d1c104c446c5c4b059d16d9e1"><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a728ac52d1c104c446c5c4b059d16d9e1">dataFromBroker</a> (const std::uint8_t *buf, std::size_t len)</td></tr>
<tr class="memdesc:a728ac52d1c104c446c5c4b059d16d9e1"><td class="mdescLeft"> </td><td class="mdescRight">Provide data received from the broker for processing. <br /></td></tr>
<tr class="separator:a728ac52d1c104c446c5c4b059d16d9e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab3ce2cc8b3a964625a6b59c70ceb8a9c" id="r_ab3ce2cc8b3a964625a6b59c70ceb8a9c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#ab3ce2cc8b3a964625a6b59c70ceb8a9c">setBrokerConnected</a> (bool connected)</td></tr>
<tr class="memdesc:ab3ce2cc8b3a964625a6b59c70ceb8a9c"><td class="mdescLeft"> </td><td class="mdescRight">Notify the <a class="el" href="classcc__mqttsn__gateway_1_1Session.html">Session</a> object about broker being connected / disconnected. <br /></td></tr>
<tr class="separator:ab3ce2cc8b3a964625a6b59c70ceb8a9c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1c37fd734a015d27bdb2360d7e311fe8" id="r_a1c37fd734a015d27bdb2360d7e311fe8"><td class="memItemLeft" align="right" valign="top"><a id="a1c37fd734a015d27bdb2360d7e311fe8" name="a1c37fd734a015d27bdb2360d7e311fe8"></a>
bool </td><td class="memItemRight" valign="bottom"><b>getBrokerConnected</b> () const</td></tr>
<tr class="memdesc:a1c37fd734a015d27bdb2360d7e311fe8"><td class="mdescLeft"> </td><td class="mdescRight">Get currently recorded broker connection status. <br /></td></tr>
<tr class="separator:a1c37fd734a015d27bdb2360d7e311fe8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a507b38d797b9e4d302ce4e9eb8acdee5" id="r_a507b38d797b9e4d302ce4e9eb8acdee5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a507b38d797b9e4d302ce4e9eb8acdee5">addPredefinedTopic</a> (const std::string &topic, std::uint16_t topicId)</td></tr>
<tr class="memdesc:a507b38d797b9e4d302ce4e9eb8acdee5"><td class="mdescLeft"> </td><td class="mdescRight">Add predefined topic string and ID information. <br /></td></tr>
<tr class="separator:a507b38d797b9e4d302ce4e9eb8acdee5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adfe4fadd74fdf75b997f10604093d91e" id="r_adfe4fadd74fdf75b997f10604093d91e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#adfe4fadd74fdf75b997f10604093d91e">setTopicIdAllocationRange</a> (std::uint16_t minVal, std::uint16_t maxVal)</td></tr>
<tr class="memdesc:adfe4fadd74fdf75b997f10604093d91e"><td class="mdescLeft"> </td><td class="mdescRight">Limit range of topic IDs allocated for newly registered topics. <br /></td></tr>
<tr class="separator:adfe4fadd74fdf75b997f10604093d91e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a18ce4af1ec9bd9368cdbe082537cac6e" name="a18ce4af1ec9bd9368cdbe082537cac6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18ce4af1ec9bd9368cdbe082537cac6e">◆ </a></span>AuthInfo</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a18ce4af1ec9bd9368cdbe082537cac6e">cc_mqttsn_gateway::Session::AuthInfo</a> = std::pair<std::string, <a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a8708e95121d9ddbfec36c7173a4fb1dd">BinaryData</a>></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of authentication information. </p>
<p>The first element of the pair is <b>username</b>, and the second element of the pair is binary <b>password</b>. </p>
</div>
</div>
<a id="af1ef7fa091dd09f74b5504f4f21fa6ef" name="af1ef7fa091dd09f74b5504f4f21fa6ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1ef7fa091dd09f74b5504f4f21fa6ef">◆ </a></span>AuthInfoReqCb</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classcc__mqttsn__gateway_1_1Session.html#af1ef7fa091dd09f74b5504f4f21fa6ef">cc_mqttsn_gateway::Session::AuthInfoReqCb</a> = std::function<<a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a18ce4af1ec9bd9368cdbe082537cac6e">AuthInfo</a> (const std::string& clientId)></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of callback used to request authentication information of the client that is trying connect. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">clientId</td><td>Client ID </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Authentication information </dd></dl>
</div>
</div>
<a id="a13c1eae248902824f4871d1680e7c6e4" name="a13c1eae248902824f4871d1680e7c6e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13c1eae248902824f4871d1680e7c6e4">◆ </a></span>BrokerReconnectReqCb</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a13c1eae248902824f4871d1680e7c6e4">cc_mqttsn_gateway::Session::BrokerReconnectReqCb</a> = std::function<void ()></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of callback used to request reconnection to the broker. </p>
<p>When the callback is invoked, the driving code must close existing TCP/IP connection to the broker and create a new one. </p>
</div>
</div>
<a id="ade8a6df2b5852e200b70ca031e0446aa" name="ade8a6df2b5852e200b70ca031e0446aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade8a6df2b5852e200b70ca031e0446aa">◆ </a></span>BrokerSendDataReqCb</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classcc__mqttsn__gateway_1_1Session.html#ade8a6df2b5852e200b70ca031e0446aa">cc_mqttsn_gateway::Session::BrokerSendDataReqCb</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 delivery of serialised message to the broker. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Buffer containing serialised 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>
<a id="a4b4ce5a131367e564c4cb629585e92b3" name="a4b4ce5a131367e564c4cb629585e92b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b4ce5a131367e564c4cb629585e92b3">◆ </a></span>CancelTickWaitReqCb</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a4b4ce5a131367e564c4cb629585e92b3">cc_mqttsn_gateway::Session::CancelTickWaitReqCb</a> = std::function<unsigned ()></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of callback, used to cancel existing time measurement. </p>
<p>When invoked the existing time measurement needs to be cancelled. The function also needs to return amount of <b>milliseconds</b> elapsed since last timer programming request. </p><dl class="section return"><dt>Returns</dt><dd>Number of elapsed <b>milliseconds</b> since last timer programming request. </dd></dl>
</div>
</div>
<a id="afae491947b50b43e3b136a727d9374f2" name="afae491947b50b43e3b136a727d9374f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afae491947b50b43e3b136a727d9374f2">◆ </a></span>ClientConnectedReportCb</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classcc__mqttsn__gateway_1_1Session.html#afae491947b50b43e3b136a727d9374f2">cc_mqttsn_gateway::Session::ClientConnectedReportCb</a> = std::function<void (const std::string& clientId)></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of callback used to report client ID of the newly connected MQTT-SN client. </p>
<p>The callback can be used to provide additional client specific information, such as predefined topic IDs. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">clientId</td><td>Client ID </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a91cde78d651a8139fbe8a6cc03809023" name="a91cde78d651a8139fbe8a6cc03809023"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91cde78d651a8139fbe8a6cc03809023">◆ </a></span>ClientSendDataReqCb</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a91cde78d651a8139fbe8a6cc03809023">cc_mqttsn_gateway::Session::ClientSendDataReqCb</a> = std::function<void (const std::uint8_t* buf, std::size_t bufSize, unsigned broadcastRadius)></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of callback, used to request delivery of serialised message to the client. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Buffer containing serialised message. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">bufSize</td><td>Number of bytes in the buffer </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">broadcastRadius</td><td>Broadcast radius. 0 means unitcast </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4a6e644c040bb2f3bd16fab845f61fc2" name="a4a6e644c040bb2f3bd16fab845f61fc2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a6e644c040bb2f3bd16fab845f61fc2">◆ </a></span>ErrorReportCb</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a4a6e644c040bb2f3bd16fab845f61fc2">cc_mqttsn_gateway::Session::ErrorReportCb</a> = std::function<void (const char* msg)></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of the callback used to report detected errors. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Error message </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7f3eeb173021e2bebd5edbbcb4e58c7d" name="a7f3eeb173021e2bebd5edbbcb4e58c7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f3eeb173021e2bebd5edbbcb4e58c7d">◆ </a></span>FwdEncSessionCreatedReportCb</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a7f3eeb173021e2bebd5edbbcb4e58c7d">cc_mqttsn_gateway::Session::FwdEncSessionCreatedReportCb</a> = std::function<bool (<a class="el" href="classcc__mqttsn__gateway_1_1Session.html">Session</a>* session)></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of callback used to notify the application about forwarding encapsulation session being created. </p>
<p>The application is responsible to perform the necessary session configuration as well as set all the callbacks except the one set by the <a class="el" href="classcc__mqttsn__gateway_1_1Session.html#abb4228612f45bc52de3d62be40f28c29">setSendDataClientReqCb()</a> and <a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a7325fc0c10dc1cae59a6ff9a2252e7ee">setTerminationReqCb()</a>. The data sent to the client as well as the session termination are managed by the calling session object. The application is responsible to manage the timer as well as broker connection of the reported session. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>Pointer to the created session object. Owned by the session object invoking the callback, mustn't be deleted by the application. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><b>true</b> in case of success, <b>false</b> in case of falure. </dd></dl>
</div>
</div>
<a id="ad75b3f3fbb8d555302375a2ae25b82e2" name="ad75b3f3fbb8d555302375a2ae25b82e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad75b3f3fbb8d555302375a2ae25b82e2">◆ </a></span>FwdEncSessionDeletedReportCb</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classcc__mqttsn__gateway_1_1Session.html#ad75b3f3fbb8d555302375a2ae25b82e2">cc_mqttsn_gateway::Session::FwdEncSessionDeletedReportCb</a> = std::function<void (<a class="el" href="classcc__mqttsn__gateway_1_1Session.html">Session</a>* session)></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of callback used to notify the application about forwarding encapsulation session being deleted. </p>
<p>The application is responsible to remove any reference to the session object from its internal data structes. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>Pointer to the created session object. Owned by the session object invoking the callback, mustn't be deleted by the application. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4d3c1b6e8a7f34189f976958e72773c0" name="a4d3c1b6e8a7f34189f976958e72773c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d3c1b6e8a7f34189f976958e72773c0">◆ </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_1Session.html#a4d3c1b6e8a7f34189f976958e72773c0">cc_mqttsn_gateway::Session::NextTickProgramReqCb</a> = std::function<void (unsigned value)></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of callback, used to request new time measurement. </p>
<p>When the requested time is due, the driving code is expected to call <a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a3d3c252c3b9aa9572d2f8f52a4fee3a6" title="Notify the Session object about requested time period expiry.">tick()</a> member function. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Number of <b>milliseconds</b> to measure. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a61bf51eecaa90806ce08c821be078b0a" name="a61bf51eecaa90806ce08c821be078b0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61bf51eecaa90806ce08c821be078b0a">◆ </a></span>TerminationReqCb</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a61bf51eecaa90806ce08c821be078b0a">cc_mqttsn_gateway::Session::TerminationReqCb</a> = std::function<void ()></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of callback, used to request session termination. </p>
<p>When the callback is invoked, the driving code must flush all the previously sent messages to appropriate I/O links and delete this session object. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a507b38d797b9e4d302ce4e9eb8acdee5" name="a507b38d797b9e4d302ce4e9eb8acdee5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a507b38d797b9e4d302ce4e9eb8acdee5">◆ </a></span>addPredefinedTopic()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool cc_mqttsn_gateway::Session::addPredefinedTopic </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>topic</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::uint16_t </td>
<td class="paramname"><em>topicId</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add predefined topic string and ID information. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">topic</td><td>Topic string </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">topicId</td><td>Numeric topic ID. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>success/failure status </dd></dl>
</div>
</div>
<a id="a728ac52d1c104c446c5c4b059d16d9e1" name="a728ac52d1c104c446c5c4b059d16d9e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a728ac52d1c104c446c5c4b059d16d9e1">◆ </a></span>dataFromBroker()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::size_t cc_mqttsn_gateway::Session::dataFromBroker </td>
<td>(</td>
<td class="paramtype">const std::uint8_t * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::size_t </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provide data received from the broker for processing. </p>
<p>This call may cause invocation of some callbacks, such as request to cancel the currently running time measurement, send new message(s) and/or (re)start time measurement. </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 the buffer of data to process. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>Number of bytes in the data buffer. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of processed bytes. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>The function returns number of bytes that were actually consumed, and can be removed from the holding buffer. </dd></dl>
</div>
</div>
<a id="a3ef4bfb2e5c6d6768ba1b9ef75e82f93" name="a3ef4bfb2e5c6d6768ba1b9ef75e82f93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ef4bfb2e5c6d6768ba1b9ef75e82f93">◆ </a></span>dataFromClient()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::size_t cc_mqttsn_gateway::Session::dataFromClient </td>
<td>(</td>
<td class="paramtype">const std::uint8_t * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::size_t </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provide data received from the client for processing. </p>
<p>This call may cause invocation of some callbacks, such as request to cancel the currently running time measurement, send new message(s) and/or (re)start time measurement. </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 the buffer of data to process. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>Number of bytes in the data buffer. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of processed bytes. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>The function returns number of bytes that were actually consumed, and can be removed from the holding buffer. </dd></dl>
</div>
</div>
<a id="ac4074b355f723b9cf16c7df90dca2b6e" name="ac4074b355f723b9cf16c7df90dca2b6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4074b355f723b9cf16c7df90dca2b6e">◆ </a></span>isRunning()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool cc_mqttsn_gateway::Session::isRunning </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether the object's operation has been successfull started. </p>
<dl class="section return"><dt>Returns</dt><dd>true/false </dd></dl>
</div>
</div>
<a id="ab519faa29c6d2386e2b305fdb2289bbf" name="ab519faa29c6d2386e2b305fdb2289bbf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab519faa29c6d2386e2b305fdb2289bbf">◆ </a></span>setAuthInfoReqCb()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cc_mqttsn_gateway::Session::setAuthInfoReqCb </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#af1ef7fa091dd09f74b5504f4f21fa6ef">AuthInfoReqCb</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 used to request authentication information for specific client. </p>
<p>This is an optional callback. It can be used when there is a need to provide authentication details (username/password) for specific clients. </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="ab3ce2cc8b3a964625a6b59c70ceb8a9c" name="ab3ce2cc8b3a964625a6b59c70ceb8a9c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab3ce2cc8b3a964625a6b59c70ceb8a9c">◆ </a></span>setBrokerConnected()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cc_mqttsn_gateway::Session::setBrokerConnected </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>connected</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Notify the <a class="el" href="classcc__mqttsn__gateway_1_1Session.html">Session</a> object about broker being connected / disconnected. </p>
<p>The report of broker being connected or disconnected must be performed only when the session's operation has been successfully started (see <a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a12513af6a5f2db6ebc57947771379bca" title="Start this object's operation.">start()</a>). Otherwise the call to this function gets ignored. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">connected</td><td>Connection status - <b>true</b> means connected, <b>false</b> disconnected. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2db095effa29cff1497342e4e0d638ac" name="a2db095effa29cff1497342e4e0d638ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2db095effa29cff1497342e4e0d638ac">◆ </a></span>setBrokerReconnectReqCb()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cc_mqttsn_gateway::Session::setBrokerReconnectReqCb </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a13c1eae248902824f4871d1680e7c6e4">BrokerReconnectReqCb</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 the session needs to close existing TCP/IP connection to the broker and open a new one. </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_1Session.html#a12513af6a5f2db6ebc57947771379bca" title="Start this object's operation.">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="a5219a534cc2f71375f1bba76e3819695" name="a5219a534cc2f71375f1bba76e3819695"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5219a534cc2f71375f1bba76e3819695">◆ </a></span>setCancelTickWaitReqCb()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cc_mqttsn_gateway::Session::setCancelTickWaitReqCb </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a4b4ce5a131367e564c4cb629585e92b3">CancelTickWaitReqCb</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 previously requested time measurement needs to be cancelled. </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_1Session.html#a12513af6a5f2db6ebc57947771379bca" title="Start this object's operation.">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="aa78b22f6b7144f598639160703376292" name="aa78b22f6b7144f598639160703376292"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa78b22f6b7144f598639160703376292">◆ </a></span>setClientConnectedReportCb()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cc_mqttsn_gateway::Session::setClientConnectedReportCb </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#afae491947b50b43e3b136a727d9374f2">ClientConnectedReportCb</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 MQTT-SN client is successfully connected to the broker. </p>
<p>This is an optional callback. It can be used when there is a need to provide client specific configuration, such as predefined topic IDs, valid only for specific client. </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="a31a9ce1bc29973c0659044f752ff3d14" name="a31a9ce1bc29973c0659044f752ff3d14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31a9ce1bc29973c0659044f752ff3d14">◆ </a></span>setDefaultClientId()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cc_mqttsn_gateway::Session::setDefaultClientId </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provide default client ID for clients that report empty one in their attempt to connect. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Default client ID string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a63ad6bad2e911a882b42fda99a827c70" name="a63ad6bad2e911a882b42fda99a827c70"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63ad6bad2e911a882b42fda99a827c70">◆ </a></span>setErrorReportCb()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cc_mqttsn_gateway::Session::setErrorReportCb </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a4a6e644c040bb2f3bd16fab845f61fc2">ErrorReportCb</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 used to report detected errors. </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="aca05f624d53ec51fb6b2db201b2dfd19" name="aca05f624d53ec51fb6b2db201b2dfd19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca05f624d53ec51fb6b2db201b2dfd19">◆ </a></span>setFwdEncSessionCreatedReportCb()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cc_mqttsn_gateway::Session::setFwdEncSessionCreatedReportCb </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a7f3eeb173021e2bebd5edbbcb4e58c7d">FwdEncSessionCreatedReportCb</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 the forwarding encapsulation session is detected and to notify application about such session creation. </p>
<p>When not set, the forwarding enapsulation messages will be ignored </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="a748fdd26e5639d274e4f28d2f3c2fe56" name="a748fdd26e5639d274e4f28d2f3c2fe56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a748fdd26e5639d274e4f28d2f3c2fe56">◆ </a></span>setFwdEncSessionDeletedReportCb()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cc_mqttsn_gateway::Session::setFwdEncSessionDeletedReportCb </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#ad75b3f3fbb8d555302375a2ae25b82e2">FwdEncSessionDeletedReportCb</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 the forwarding encapsulation session is about to be deleted. </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="a6120e5c84cfa3e7a577c28ce5351cd2f" name="a6120e5c84cfa3e7a577c28ce5351cd2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6120e5c84cfa3e7a577c28ce5351cd2f">◆ </a></span>setGatewayId()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cc_mqttsn_gateway::Session::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 reported when requested. </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="ad03abf3c8beaad947016bea6a5e66d85" name="ad03abf3c8beaad947016bea6a5e66d85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad03abf3c8beaad947016bea6a5e66d85">◆ </a></span>setNextTickProgramReqCb()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cc_mqttsn_gateway::Session::setNextTickProgramReqCb </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcc__mqttsn__gateway_1_1Session.html#a4d3c1b6e8a7f34189f976958e72773c0">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_1Session.html#a12513af6a5f2db6ebc57947771379bca" title="Start this object's operation.">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="ad9933a5769200858d7faa2bf1f374d82" name="ad9933a5769200858d7faa2bf1f374d82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9933a5769200858d7faa2bf1f374d82">◆ </a></span>setPubOnlyKeepAlive()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cc_mqttsn_gateway::Session::setPubOnlyKeepAlive </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>Provide default "keep alive" period for "publish only" clients, that do not make an attempt to connect to the gateway. </p>
<p>MQTT-SN protocol allows "publish only" clients that don't make any attempt to connect to the gateway/broker and send all their messages with QoS=-1. In this case, the gateway must connect to the broker on behalf of the "publish only" client. Such connection attempt requires to specify "keep alive" period. Use this function to set the value. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Max number of seconds between messages the "publish only" client is going to send. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a65eea77d5c98b46c5ac12053976b0771" name="a65eea77d5c98b46c5ac12053976b0771"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65eea77d5c98b46c5ac12053976b0771">◆ </a></span>setRetryCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cc_mqttsn_gateway::Session::setRetryCount </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set number of retry attempts to perform before abandoning attempt to send unacknowledged message. </p>
<p>Some messages, may require acknowledgement by the client and/or broker. The amount of retry attempts before abandoning the attempt to deliver the message may be specified using this function. The default value is <b>3</b>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Number of retry attempts. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4159f98133b10a30982ee6c54e7c9be6" name="a4159f98133b10a30982ee6c54e7c9be6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4159f98133b10a30982ee6c54e7c9be6">◆ </a></span>setRetryPeriod()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cc_mqttsn_gateway::Session::setRetryPeriod </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set retry period to wait between resending unacknowledged message to the client and/or broker. </p>
<p>Some messages, may require acknowledgement by the client and/or broker. The delay (in seconds) between such attempts to resend the message may be specified using this function. The default value is <b>10</b> seconds. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Number of <b>seconds</b> to wait before making an attempt to resend. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a230c8f69e352f9314286990f5d0979f4" name="a230c8f69e352f9314286990f5d0979f4"></a>