-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgroup__subscribe.html
709 lines (662 loc) · 48.9 KB
/
group__subscribe.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
<!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>CommsChampion Ecosystem MQTT v5 Client: "Subscribe Operation Data Type and Functions"</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">CommsChampion Ecosystem MQTT v5 Client
</div>
<div id="projectbrief">MQTT v5 Client Library.</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>
</div><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">"Subscribe Operation Data Type and Functions"</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structCC__Mqtt5SubscribeExtraConfig.html">CC_Mqtt5SubscribeExtraConfig</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Extra subscription properties configuration structure. <a href="structCC__Mqtt5SubscribeExtraConfig.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structCC__Mqtt5SubscribeResponse.html">CC_Mqtt5SubscribeResponse</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Response information from broker to "subscribe" request. <a href="structCC__Mqtt5SubscribeResponse.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structCC__Mqtt5SubscribeTopicConfig.html">CC_Mqtt5SubscribeTopicConfig</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Topic filter configuration structure of the "subscribe" operation. <a href="structCC__Mqtt5SubscribeTopicConfig.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga6e830ba5fe0ac04d19c72acc7a9eab26" id="r_ga6e830ba5fe0ac04d19c72acc7a9eab26"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__subscribe.html#ga6e830ba5fe0ac04d19c72acc7a9eab26">CC_Mqtt5SubscribeCompleteCb</a>) (void *data, <a class="el" href="group__subscribe.html#ga9d0e682b1376656ecedaec1c00e6948d">CC_Mqtt5SubscribeHandle</a> handle, <a class="el" href="group__global.html#gabd56266bda747f19e4c6669fa0da021d">CC_Mqtt5AsyncOpStatus</a> status, const <a class="el" href="structCC__Mqtt5SubscribeResponse.html">CC_Mqtt5SubscribeResponse</a> *response)</td></tr>
<tr class="memdesc:ga6e830ba5fe0ac04d19c72acc7a9eab26"><td class="mdescLeft"> </td><td class="mdescRight">Callback used to report completion of the "subscribe" operation. <br /></td></tr>
<tr class="separator:ga6e830ba5fe0ac04d19c72acc7a9eab26"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9d0e682b1376656ecedaec1c00e6948d" id="r_ga9d0e682b1376656ecedaec1c00e6948d"><td class="memItemLeft" align="right" valign="top">typedef struct CC_Mqtt5Subscribe * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__subscribe.html#ga9d0e682b1376656ecedaec1c00e6948d">CC_Mqtt5SubscribeHandle</a></td></tr>
<tr class="memdesc:ga9d0e682b1376656ecedaec1c00e6948d"><td class="mdescLeft"> </td><td class="mdescRight">Handle for "subscribe" operation. <br /></td></tr>
<tr class="separator:ga9d0e682b1376656ecedaec1c00e6948d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gabfd846ede45f77ffed9847de11b6b0a6" id="r_gabfd846ede45f77ffed9847de11b6b0a6"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__subscribe.html#gabfd846ede45f77ffed9847de11b6b0a6">CC_Mqtt5RetainHandling</a> { <a class="el" href="group__subscribe.html#ggabfd846ede45f77ffed9847de11b6b0a6a6400a1d538d187e304a19b26e6d69a4d">CC_Mqtt5RetainHandling_Send</a> = 0
, <a class="el" href="group__subscribe.html#ggabfd846ede45f77ffed9847de11b6b0a6acaf3867058bcc78b371043523c55ec45">CC_Mqtt5RetainHandling_SendIfDoesNotExist</a> = 1
, <a class="el" href="group__subscribe.html#ggabfd846ede45f77ffed9847de11b6b0a6a8248cdd5e346ea4bc14bbe2f9db5bfb5">CC_Mqtt5RetainHandling_DoNotSend</a> = 2
, <a class="el" href="group__subscribe.html#ggabfd846ede45f77ffed9847de11b6b0a6af53ba74ee13e0d14df33305553af3b8b">CC_Mqtt5RetainHandling_ValuesLimit</a>
}</td></tr>
<tr class="memdesc:gabfd846ede45f77ffed9847de11b6b0a6"><td class="mdescLeft"> </td><td class="mdescRight">"Retain Handling" option as defined by the MQTT v5 specification. <a href="group__subscribe.html#gabfd846ede45f77ffed9847de11b6b0a6">More...</a><br /></td></tr>
<tr class="separator:gabfd846ede45f77ffed9847de11b6b0a6"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga48fad52b98d93cb7d952c9bae76857e2" id="r_ga48fad52b98d93cb7d952c9bae76857e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__subscribe.html#ga48fad52b98d93cb7d952c9bae76857e2">cc_mqtt5_client_subscribe_add_user_prop</a> (<a class="el" href="group__subscribe.html#ga9d0e682b1376656ecedaec1c00e6948d">CC_Mqtt5SubscribeHandle</a> handle, const <a class="el" href="structCC__Mqtt5UserProp.html">CC_Mqtt5UserProp</a> *prop)</td></tr>
<tr class="memdesc:ga48fad52b98d93cb7d952c9bae76857e2"><td class="mdescLeft"> </td><td class="mdescRight">Add user property to the configuration of the "subscribe" operation. <br /></td></tr>
<tr class="separator:ga48fad52b98d93cb7d952c9bae76857e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7c531c03aa1f45a139aa6c89dbd5cae5" id="r_ga7c531c03aa1f45a139aa6c89dbd5cae5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__subscribe.html#ga7c531c03aa1f45a139aa6c89dbd5cae5">cc_mqtt5_client_subscribe_cancel</a> (<a class="el" href="group__subscribe.html#ga9d0e682b1376656ecedaec1c00e6948d">CC_Mqtt5SubscribeHandle</a> handle)</td></tr>
<tr class="memdesc:ga7c531c03aa1f45a139aa6c89dbd5cae5"><td class="mdescLeft"> </td><td class="mdescRight">Cancel the allocated "subscribe" operation. <br /></td></tr>
<tr class="separator:ga7c531c03aa1f45a139aa6c89dbd5cae5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2de37f3b0f17471d26d3488cc3f9a446" id="r_ga2de37f3b0f17471d26d3488cc3f9a446"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__subscribe.html#ga2de37f3b0f17471d26d3488cc3f9a446">cc_mqtt5_client_subscribe_config_extra</a> (<a class="el" href="group__subscribe.html#ga9d0e682b1376656ecedaec1c00e6948d">CC_Mqtt5SubscribeHandle</a> handle, const <a class="el" href="structCC__Mqtt5SubscribeExtraConfig.html">CC_Mqtt5SubscribeExtraConfig</a> *config)</td></tr>
<tr class="memdesc:ga2de37f3b0f17471d26d3488cc3f9a446"><td class="mdescLeft"> </td><td class="mdescRight">Perform extra properties configuration of the "subscribe" operation. <br /></td></tr>
<tr class="separator:ga2de37f3b0f17471d26d3488cc3f9a446"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2f344bdcb7224dd2a2371f982117e4f7" id="r_ga2f344bdcb7224dd2a2371f982117e4f7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__subscribe.html#ga2f344bdcb7224dd2a2371f982117e4f7">cc_mqtt5_client_subscribe_config_topic</a> (<a class="el" href="group__subscribe.html#ga9d0e682b1376656ecedaec1c00e6948d">CC_Mqtt5SubscribeHandle</a> handle, const <a class="el" href="structCC__Mqtt5SubscribeTopicConfig.html">CC_Mqtt5SubscribeTopicConfig</a> *config)</td></tr>
<tr class="memdesc:ga2f344bdcb7224dd2a2371f982117e4f7"><td class="mdescLeft"> </td><td class="mdescRight">Add topic configuration of the "subscribe" operation. <br /></td></tr>
<tr class="separator:ga2f344bdcb7224dd2a2371f982117e4f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4b6c6f0de4fd4758e28eb959d619ee16" id="r_ga4b6c6f0de4fd4758e28eb959d619ee16"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__subscribe.html#ga4b6c6f0de4fd4758e28eb959d619ee16">cc_mqtt5_client_subscribe_full</a> (<a class="el" href="group__client.html#ga6c225736aebda7ec79fca5701036ed15">CC_Mqtt5ClientHandle</a> handle, const <a class="el" href="structCC__Mqtt5SubscribeTopicConfig.html">CC_Mqtt5SubscribeTopicConfig</a> *topicConfigs, unsigned topicConfigsCount, const <a class="el" href="structCC__Mqtt5SubscribeExtraConfig.html">CC_Mqtt5SubscribeExtraConfig</a> *extraConfig, <a class="el" href="group__subscribe.html#ga6e830ba5fe0ac04d19c72acc7a9eab26">CC_Mqtt5SubscribeCompleteCb</a> cb, void *cbData)</td></tr>
<tr class="memdesc:ga4b6c6f0de4fd4758e28eb959d619ee16"><td class="mdescLeft"> </td><td class="mdescRight">Prepare, configure, and send "subscribe" request in one go (full version) <br /></td></tr>
<tr class="separator:ga4b6c6f0de4fd4758e28eb959d619ee16"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabcf467b326c8117a7ba95b21540c7b39" id="r_gabcf467b326c8117a7ba95b21540c7b39"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="group__subscribe.html#gabcf467b326c8117a7ba95b21540c7b39">cc_mqtt5_client_subscribe_get_response_timeout</a> (<a class="el" href="group__subscribe.html#ga9d0e682b1376656ecedaec1c00e6948d">CC_Mqtt5SubscribeHandle</a> handle)</td></tr>
<tr class="memdesc:gabcf467b326c8117a7ba95b21540c7b39"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the configured the broker response timeout for the "subscribe" operation. <br /></td></tr>
<tr class="separator:gabcf467b326c8117a7ba95b21540c7b39"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaff1b806c1b382a7a41fabf09f2928577" id="r_gaff1b806c1b382a7a41fabf09f2928577"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__subscribe.html#gaff1b806c1b382a7a41fabf09f2928577">cc_mqtt5_client_subscribe_init_config_extra</a> (<a class="el" href="structCC__Mqtt5SubscribeExtraConfig.html">CC_Mqtt5SubscribeExtraConfig</a> *config)</td></tr>
<tr class="memdesc:gaff1b806c1b382a7a41fabf09f2928577"><td class="mdescLeft"> </td><td class="mdescRight">Intialize the <a class="el" href="structCC__Mqtt5SubscribeExtraConfig.html">CC_Mqtt5SubscribeExtraConfig</a> configuration structure. <br /></td></tr>
<tr class="separator:gaff1b806c1b382a7a41fabf09f2928577"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabeff7363174cab7ab34bb045af931df9" id="r_gabeff7363174cab7ab34bb045af931df9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__subscribe.html#gabeff7363174cab7ab34bb045af931df9">cc_mqtt5_client_subscribe_init_config_topic</a> (<a class="el" href="structCC__Mqtt5SubscribeTopicConfig.html">CC_Mqtt5SubscribeTopicConfig</a> *config)</td></tr>
<tr class="memdesc:gabeff7363174cab7ab34bb045af931df9"><td class="mdescLeft"> </td><td class="mdescRight">Intialize the <a class="el" href="structCC__Mqtt5SubscribeTopicConfig.html">CC_Mqtt5SubscribeTopicConfig</a> configuration structure. <br /></td></tr>
<tr class="separator:gabeff7363174cab7ab34bb045af931df9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1cbf32eb3f9d11ae96e50d9570deb403" id="r_ga1cbf32eb3f9d11ae96e50d9570deb403"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__subscribe.html#ga9d0e682b1376656ecedaec1c00e6948d">CC_Mqtt5SubscribeHandle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__subscribe.html#ga1cbf32eb3f9d11ae96e50d9570deb403">cc_mqtt5_client_subscribe_prepare</a> (<a class="el" href="group__client.html#ga6c225736aebda7ec79fca5701036ed15">CC_Mqtt5ClientHandle</a> handle, <a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> *ec)</td></tr>
<tr class="memdesc:ga1cbf32eb3f9d11ae96e50d9570deb403"><td class="mdescLeft"> </td><td class="mdescRight">Prepare "subscribe" operation. <br /></td></tr>
<tr class="separator:ga1cbf32eb3f9d11ae96e50d9570deb403"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadaeca4f9381ece1a7d23bb4a7a3ea7c8" id="r_gadaeca4f9381ece1a7d23bb4a7a3ea7c8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__subscribe.html#gadaeca4f9381ece1a7d23bb4a7a3ea7c8">cc_mqtt5_client_subscribe_send</a> (<a class="el" href="group__subscribe.html#ga9d0e682b1376656ecedaec1c00e6948d">CC_Mqtt5SubscribeHandle</a> handle, <a class="el" href="group__subscribe.html#ga6e830ba5fe0ac04d19c72acc7a9eab26">CC_Mqtt5SubscribeCompleteCb</a> cb, void *cbData)</td></tr>
<tr class="memdesc:gadaeca4f9381ece1a7d23bb4a7a3ea7c8"><td class="mdescLeft"> </td><td class="mdescRight">Send the configured "subscribe" operation to broker. <br /></td></tr>
<tr class="separator:gadaeca4f9381ece1a7d23bb4a7a3ea7c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2bb2748e02ed4ec2fe11f3525f39b10e" id="r_ga2bb2748e02ed4ec2fe11f3525f39b10e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__subscribe.html#ga2bb2748e02ed4ec2fe11f3525f39b10e">cc_mqtt5_client_subscribe_set_response_timeout</a> (<a class="el" href="group__subscribe.html#ga9d0e682b1376656ecedaec1c00e6948d">CC_Mqtt5SubscribeHandle</a> handle, unsigned ms)</td></tr>
<tr class="memdesc:ga2bb2748e02ed4ec2fe11f3525f39b10e"><td class="mdescLeft"> </td><td class="mdescRight">Configure the broker response timeout for the "subscribe" operation. <br /></td></tr>
<tr class="separator:ga2bb2748e02ed4ec2fe11f3525f39b10e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab1c45cd64ba30ce4c6452abd2e223163" id="r_gab1c45cd64ba30ce4c6452abd2e223163"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__subscribe.html#gab1c45cd64ba30ce4c6452abd2e223163">cc_mqtt5_client_subscribe_simple</a> (<a class="el" href="group__client.html#ga6c225736aebda7ec79fca5701036ed15">CC_Mqtt5ClientHandle</a> handle, const <a class="el" href="structCC__Mqtt5SubscribeTopicConfig.html">CC_Mqtt5SubscribeTopicConfig</a> *topicConfig, <a class="el" href="group__subscribe.html#ga6e830ba5fe0ac04d19c72acc7a9eab26">CC_Mqtt5SubscribeCompleteCb</a> cb, void *cbData)</td></tr>
<tr class="memdesc:gab1c45cd64ba30ce4c6452abd2e223163"><td class="mdescLeft"> </td><td class="mdescRight">Prepare, configure, and send "subscribe" request in one go (simple version) <br /></td></tr>
<tr class="separator:gab1c45cd64ba30ce4c6452abd2e223163"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga6e830ba5fe0ac04d19c72acc7a9eab26" name="ga6e830ba5fe0ac04d19c72acc7a9eab26"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6e830ba5fe0ac04d19c72acc7a9eab26">◆ </a></span>CC_Mqtt5SubscribeCompleteCb</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* CC_Mqtt5SubscribeCompleteCb) (void *data, <a class="el" href="group__subscribe.html#ga9d0e682b1376656ecedaec1c00e6948d">CC_Mqtt5SubscribeHandle</a> handle, <a class="el" href="group__global.html#gabd56266bda747f19e4c6669fa0da021d">CC_Mqtt5AsyncOpStatus</a> status, const <a class="el" href="structCC__Mqtt5SubscribeResponse.html">CC_Mqtt5SubscribeResponse</a> *response)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback used to report completion of the "subscribe" operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Pointer to user data object passed as last parameter to the <b><a class="el" href="group__subscribe.html#gadaeca4f9381ece1a7d23bb4a7a3ea7c8" title="Send the configured "subscribe" operation to broker.">cc_mqtt5_client_subscribe_send()</a></b>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <b><a class="el" href="group__subscribe.html#ga1cbf32eb3f9d11ae96e50d9570deb403" title="Prepare "subscribe" operation.">cc_mqtt5_client_subscribe_prepare()</a></b> function. When the callback is invoked the handle is already invalid and cannot be used in any relevant function invocation, but it allows end application to identify the original "subscribe" operation and use the same callback function in parallel requests. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">status</td><td>Status of the "subscribe" operation. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">response</td><td>Response information from the broker. Not-NULL is reported <b>if and onfly if</b> the "status" is equal to <a class="el" href="group__global.html#ggabd56266bda747f19e4c6669fa0da021da1612bd223303ddf181264c196d24855d">CC_Mqtt5AsyncOpStatus_Complete</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section post"><dt>Postcondition</dt><dd>The data members of the reported response can NOT be accessed after the function returns. </dd></dl>
</div>
</div>
<a id="ga9d0e682b1376656ecedaec1c00e6948d" name="ga9d0e682b1376656ecedaec1c00e6948d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9d0e682b1376656ecedaec1c00e6948d">◆ </a></span>CC_Mqtt5SubscribeHandle</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct CC_Mqtt5Subscribe* <a class="el" href="group__subscribe.html#ga9d0e682b1376656ecedaec1c00e6948d">CC_Mqtt5SubscribeHandle</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Handle for "subscribe" operation. </p>
<p>Returned by <a class="el" href="group__subscribe.html#ga1cbf32eb3f9d11ae96e50d9570deb403" title="Prepare "subscribe" operation.">cc_mqtt5_client_subscribe_prepare()</a> function. </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="gabfd846ede45f77ffed9847de11b6b0a6" name="gabfd846ede45f77ffed9847de11b6b0a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabfd846ede45f77ffed9847de11b6b0a6">◆ </a></span>CC_Mqtt5RetainHandling</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__subscribe.html#gabfd846ede45f77ffed9847de11b6b0a6">CC_Mqtt5RetainHandling</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>"Retain Handling" option as defined by the MQTT v5 specification. </p>
<p>It is used during the "subscribe" operation topic configuration. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggabfd846ede45f77ffed9847de11b6b0a6a6400a1d538d187e304a19b26e6d69a4d" name="ggabfd846ede45f77ffed9847de11b6b0a6a6400a1d538d187e304a19b26e6d69a4d"></a>CC_Mqtt5RetainHandling_Send </td><td class="fielddoc"><p>Send retained messages at the time of the subscribe. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggabfd846ede45f77ffed9847de11b6b0a6acaf3867058bcc78b371043523c55ec45" name="ggabfd846ede45f77ffed9847de11b6b0a6acaf3867058bcc78b371043523c55ec45"></a>CC_Mqtt5RetainHandling_SendIfDoesNotExist </td><td class="fielddoc"><p>Send retained messages at subscribe only if the subscription does not currently exist. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggabfd846ede45f77ffed9847de11b6b0a6a8248cdd5e346ea4bc14bbe2f9db5bfb5" name="ggabfd846ede45f77ffed9847de11b6b0a6a8248cdd5e346ea4bc14bbe2f9db5bfb5"></a>CC_Mqtt5RetainHandling_DoNotSend </td><td class="fielddoc"><p>Do not send retained messages at the time of the subscribe. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggabfd846ede45f77ffed9847de11b6b0a6af53ba74ee13e0d14df33305553af3b8b" name="ggabfd846ede45f77ffed9847de11b6b0a6af53ba74ee13e0d14df33305553af3b8b"></a>CC_Mqtt5RetainHandling_ValuesLimit </td><td class="fielddoc"><p>Limit for the values. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga48fad52b98d93cb7d952c9bae76857e2" name="ga48fad52b98d93cb7d952c9bae76857e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga48fad52b98d93cb7d952c9bae76857e2">◆ </a></span>cc_mqtt5_client_subscribe_add_user_prop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> cc_mqtt5_client_subscribe_add_user_prop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__subscribe.html#ga9d0e682b1376656ecedaec1c00e6948d">CC_Mqtt5SubscribeHandle</a> </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structCC__Mqtt5UserProp.html">CC_Mqtt5UserProp</a> * </td>
<td class="paramname"><em>prop</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add user property to the configuration of the "subscribe" operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__subscribe.html#ga1cbf32eb3f9d11ae96e50d9570deb403">cc_mqtt5_client_subscribe_prepare()</a> function. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">prop</td><td>Single user property info. Must NOT be NULL. Does not need to be preserved after invocation. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code of the call. </dd></dl>
</div>
</div>
<a id="ga7c531c03aa1f45a139aa6c89dbd5cae5" name="ga7c531c03aa1f45a139aa6c89dbd5cae5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7c531c03aa1f45a139aa6c89dbd5cae5">◆ </a></span>cc_mqtt5_client_subscribe_cancel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> cc_mqtt5_client_subscribe_cancel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__subscribe.html#ga9d0e682b1376656ecedaec1c00e6948d">CC_Mqtt5SubscribeHandle</a> </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Cancel the allocated "subscribe" operation. </p>
<p>In case the <a class="el" href="group__subscribe.html#gadaeca4f9381ece1a7d23bb4a7a3ea7c8">cc_mqtt5_client_subscribe_send()</a> function was successfully called before, the operation is cancelled <b>without</b> callback invocation. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__subscribe.html#ga1cbf32eb3f9d11ae96e50d9570deb403">cc_mqtt5_client_subscribe_prepare()</a> function. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code of the call. </dd></dl>
<dl class="section post"><dt>Postcondition</dt><dd>The handle of the "subscribe" operation is no longer valid and must be discarded. </dd></dl>
</div>
</div>
<a id="ga2de37f3b0f17471d26d3488cc3f9a446" name="ga2de37f3b0f17471d26d3488cc3f9a446"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2de37f3b0f17471d26d3488cc3f9a446">◆ </a></span>cc_mqtt5_client_subscribe_config_extra()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> cc_mqtt5_client_subscribe_config_extra </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__subscribe.html#ga9d0e682b1376656ecedaec1c00e6948d">CC_Mqtt5SubscribeHandle</a> </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structCC__Mqtt5SubscribeExtraConfig.html">CC_Mqtt5SubscribeExtraConfig</a> * </td>
<td class="paramname"><em>config</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Perform extra properties configuration of the "subscribe" operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__subscribe.html#ga1cbf32eb3f9d11ae96e50d9570deb403">cc_mqtt5_client_subscribe_prepare()</a> function. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">config</td><td>Extra properties configuration structure. Must NOT be NULL. Does not need to be preserved after invocation. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code of the call. </dd></dl>
<dl class="section pre"><dt>Precondition</dt><dd>Mustn't be called more than once for a single "subscribe" operation. </dd></dl>
</div>
</div>
<a id="ga2f344bdcb7224dd2a2371f982117e4f7" name="ga2f344bdcb7224dd2a2371f982117e4f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2f344bdcb7224dd2a2371f982117e4f7">◆ </a></span>cc_mqtt5_client_subscribe_config_topic()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> cc_mqtt5_client_subscribe_config_topic </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__subscribe.html#ga9d0e682b1376656ecedaec1c00e6948d">CC_Mqtt5SubscribeHandle</a> </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structCC__Mqtt5SubscribeTopicConfig.html">CC_Mqtt5SubscribeTopicConfig</a> * </td>
<td class="paramname"><em>config</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add topic configuration of the "subscribe" operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__subscribe.html#ga1cbf32eb3f9d11ae96e50d9570deb403">cc_mqtt5_client_subscribe_prepare()</a> function. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">config</td><td>Topic configuration structure. Must NOT be NULL. Does not need to be preserved after invocation. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code of the call. </dd></dl>
</div>
</div>
<a id="ga4b6c6f0de4fd4758e28eb959d619ee16" name="ga4b6c6f0de4fd4758e28eb959d619ee16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4b6c6f0de4fd4758e28eb959d619ee16">◆ </a></span>cc_mqtt5_client_subscribe_full()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> cc_mqtt5_client_subscribe_full </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__client.html#ga6c225736aebda7ec79fca5701036ed15">CC_Mqtt5ClientHandle</a> </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structCC__Mqtt5SubscribeTopicConfig.html">CC_Mqtt5SubscribeTopicConfig</a> * </td>
<td class="paramname"><em>topicConfigs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>topicConfigsCount</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structCC__Mqtt5SubscribeExtraConfig.html">CC_Mqtt5SubscribeExtraConfig</a> * </td>
<td class="paramname"><em>extraConfig</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__subscribe.html#ga6e830ba5fe0ac04d19c72acc7a9eab26">CC_Mqtt5SubscribeCompleteCb</a> </td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>cbData</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Prepare, configure, and send "subscribe" request in one go (full version) </p>
<p>Abstracts away sequence of the following functions invocation: </p><ul>
<li><a class="el" href="group__subscribe.html#ga1cbf32eb3f9d11ae96e50d9570deb403">cc_mqtt5_client_subscribe_prepare()</a> </li>
<li><a class="el" href="group__subscribe.html#ga2f344bdcb7224dd2a2371f982117e4f7">cc_mqtt5_client_subscribe_config_topic()</a> (multiple times) </li>
<li><a class="el" href="group__subscribe.html#ga2de37f3b0f17471d26d3488cc3f9a446">cc_mqtt5_client_subscribe_config_extra()</a> </li>
<li><a class="el" href="group__subscribe.html#gadaeca4f9381ece1a7d23bb4a7a3ea7c8">cc_mqtt5_client_subscribe_send()</a></li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__client.html#gaa955f88ddca4c7b695074312b5a8cbee">cc_mqtt5_client_alloc()</a> function. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">topicConfigs</td><td>Pointer to array of the topic configurations. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">topicConfigsCount</td><td>Amount of the topic configurations in the array. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">extraConfig</td><td>Extra configuration. Can be NULL. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cb</td><td>Callback to be invoked when "subscribe" operation is complete. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cbData</td><td>Pointer to any user data structure. It will passed as one of the parameters in callback invocation. May be NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code of the call. </dd></dl>
</div>
</div>
<a id="gabcf467b326c8117a7ba95b21540c7b39" name="gabcf467b326c8117a7ba95b21540c7b39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabcf467b326c8117a7ba95b21540c7b39">◆ </a></span>cc_mqtt5_client_subscribe_get_response_timeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned cc_mqtt5_client_subscribe_get_response_timeout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__subscribe.html#ga9d0e682b1376656ecedaec1c00e6948d">CC_Mqtt5SubscribeHandle</a> </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the configured the broker response timeout for the "subscribe" operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__subscribe.html#ga1cbf32eb3f9d11ae96e50d9570deb403">cc_mqtt5_client_subscribe_prepare()</a> function. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Response timeout duration in <b>milliseconds</b>. </dd></dl>
</div>
</div>
<a id="gaff1b806c1b382a7a41fabf09f2928577" name="gaff1b806c1b382a7a41fabf09f2928577"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaff1b806c1b382a7a41fabf09f2928577">◆ </a></span>cc_mqtt5_client_subscribe_init_config_extra()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cc_mqtt5_client_subscribe_init_config_extra </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structCC__Mqtt5SubscribeExtraConfig.html">CC_Mqtt5SubscribeExtraConfig</a> * </td>
<td class="paramname"><em>config</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Intialize the <a class="el" href="structCC__Mqtt5SubscribeExtraConfig.html">CC_Mqtt5SubscribeExtraConfig</a> configuration structure. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">config</td><td>Configuration structure. Must not be NULL. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gabeff7363174cab7ab34bb045af931df9" name="gabeff7363174cab7ab34bb045af931df9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabeff7363174cab7ab34bb045af931df9">◆ </a></span>cc_mqtt5_client_subscribe_init_config_topic()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cc_mqtt5_client_subscribe_init_config_topic </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structCC__Mqtt5SubscribeTopicConfig.html">CC_Mqtt5SubscribeTopicConfig</a> * </td>
<td class="paramname"><em>config</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Intialize the <a class="el" href="structCC__Mqtt5SubscribeTopicConfig.html">CC_Mqtt5SubscribeTopicConfig</a> configuration structure. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">config</td><td>Configuration structure. Must not be NULL. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga1cbf32eb3f9d11ae96e50d9570deb403" name="ga1cbf32eb3f9d11ae96e50d9570deb403"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1cbf32eb3f9d11ae96e50d9570deb403">◆ </a></span>cc_mqtt5_client_subscribe_prepare()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__subscribe.html#ga9d0e682b1376656ecedaec1c00e6948d">CC_Mqtt5SubscribeHandle</a> cc_mqtt5_client_subscribe_prepare </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__client.html#ga6c225736aebda7ec79fca5701036ed15">CC_Mqtt5ClientHandle</a> </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> * </td>
<td class="paramname"><em>ec</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Prepare "subscribe" operation. </p>
<p>For successful operation the client needs to be in the "connected" state. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__client.html#gaa955f88ddca4c7b695074312b5a8cbee">cc_mqtt5_client_alloc()</a> function. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">ec</td><td>Error code reporting result of the operation. Can be NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Handle of the "subscribe" operation, will be NULL in case of failure. To analyze the reason failure use "ec" output parameter. </dd></dl>
<dl class="section post"><dt>Postcondition</dt><dd>The "subscribe" operation is allocated, use either <a class="el" href="group__subscribe.html#gadaeca4f9381ece1a7d23bb4a7a3ea7c8">cc_mqtt5_client_subscribe_send()</a> or <a class="el" href="group__subscribe.html#ga7c531c03aa1f45a139aa6c89dbd5cae5">cc_mqtt5_client_subscribe_cancel()</a> to prevent memory leaks. </dd></dl>
</div>
</div>
<a id="gadaeca4f9381ece1a7d23bb4a7a3ea7c8" name="gadaeca4f9381ece1a7d23bb4a7a3ea7c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadaeca4f9381ece1a7d23bb4a7a3ea7c8">◆ </a></span>cc_mqtt5_client_subscribe_send()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> cc_mqtt5_client_subscribe_send </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__subscribe.html#ga9d0e682b1376656ecedaec1c00e6948d">CC_Mqtt5SubscribeHandle</a> </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__subscribe.html#ga6e830ba5fe0ac04d19c72acc7a9eab26">CC_Mqtt5SubscribeCompleteCb</a> </td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>cbData</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send the configured "subscribe" operation to broker. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__subscribe.html#ga1cbf32eb3f9d11ae96e50d9570deb403">cc_mqtt5_client_subscribe_prepare()</a> function. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cb</td><td>Callback to be invoked when "subscribe" operation is complete. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cbData</td><td>Pointer to any user data structure. It will passed as one of the parameters in callback invocation. May be NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code of the call. </dd></dl>
<dl class="section pre"><dt>Precondition</dt><dd>At least one topic has been configured using <a class="el" href="group__subscribe.html#ga2f344bdcb7224dd2a2371f982117e4f7">cc_mqtt5_client_subscribe_config_topic</a>. </dd></dl>
<dl class="section post"><dt>Postcondition</dt><dd>The handle of the "subscribe" operation can be discarded. </dd>
<dd>
The provided callback will be invoked when the "subscribe" operation is complete <b> if and only if</b> the function returns <a class="el" href="group__global.html#ggac9c64dc7d5a785e8b22d7faaaf6f9beaa8f6454b1f4f259f82322e3b5517a4d63">CC_Mqtt5ErrorCode_Success</a>. </dd></dl>
</div>
</div>
<a id="ga2bb2748e02ed4ec2fe11f3525f39b10e" name="ga2bb2748e02ed4ec2fe11f3525f39b10e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2bb2748e02ed4ec2fe11f3525f39b10e">◆ </a></span>cc_mqtt5_client_subscribe_set_response_timeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> cc_mqtt5_client_subscribe_set_response_timeout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__subscribe.html#ga9d0e682b1376656ecedaec1c00e6948d">CC_Mqtt5SubscribeHandle</a> </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>ms</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Configure the broker response timeout for the "subscribe" operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__subscribe.html#ga1cbf32eb3f9d11ae96e50d9570deb403">cc_mqtt5_client_subscribe_prepare()</a> function. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ms</td><td>Response timeout duration in <b>milliseconds</b>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code of the call. </dd></dl>
</div>
</div>
<a id="gab1c45cd64ba30ce4c6452abd2e223163" name="gab1c45cd64ba30ce4c6452abd2e223163"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab1c45cd64ba30ce4c6452abd2e223163">◆ </a></span>cc_mqtt5_client_subscribe_simple()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> cc_mqtt5_client_subscribe_simple </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__client.html#ga6c225736aebda7ec79fca5701036ed15">CC_Mqtt5ClientHandle</a> </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structCC__Mqtt5SubscribeTopicConfig.html">CC_Mqtt5SubscribeTopicConfig</a> * </td>
<td class="paramname"><em>topicConfig</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__subscribe.html#ga6e830ba5fe0ac04d19c72acc7a9eab26">CC_Mqtt5SubscribeCompleteCb</a> </td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>cbData</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Prepare, configure, and send "subscribe" request in one go (simple version) </p>
<p>Abstracts away sequence of the following functions invocation: </p><ul>
<li><a class="el" href="group__subscribe.html#ga1cbf32eb3f9d11ae96e50d9570deb403">cc_mqtt5_client_subscribe_prepare()</a> </li>
<li><a class="el" href="group__subscribe.html#ga2f344bdcb7224dd2a2371f982117e4f7">cc_mqtt5_client_subscribe_config_topic()</a> </li>
<li><a class="el" href="group__subscribe.html#gadaeca4f9381ece1a7d23bb4a7a3ea7c8">cc_mqtt5_client_subscribe_send()</a></li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__client.html#gaa955f88ddca4c7b695074312b5a8cbee">cc_mqtt5_client_alloc()</a> function. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">topicConfig</td><td>Topic configuration. Can be NULL. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cb</td><td>Callback to be invoked when "subscribe" operation is complete. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cbData</td><td>Pointer to any user data structure. It will passed as one of the parameters in callback invocation. May be NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code of the call. </dd></dl>
</div>
</div>
</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>