-
Notifications
You must be signed in to change notification settings - Fork 0
/
group__global.html
643 lines (611 loc) · 63.3 KB
/
group__global.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
<!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: "Global Data Types 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="#define-members">Macros</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">"Global Data Types 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__Mqtt5AuthConfig.html">CC_Mqtt5AuthConfig</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Authentication Configuration. <a href="structCC__Mqtt5AuthConfig.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__Mqtt5AuthInfo.html">CC_Mqtt5AuthInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Authentication handshake information. <a href="structCC__Mqtt5AuthInfo.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__Mqtt5DisconnectInfo.html">CC_Mqtt5DisconnectInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Broker disconnection information. <a href="structCC__Mqtt5DisconnectInfo.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__Mqtt5MessageInfo.html">CC_Mqtt5MessageInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Received message information. <a href="structCC__Mqtt5MessageInfo.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__Mqtt5UserProp.html">CC_Mqtt5UserProp</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Wraping structre of the single "User Property". <a href="structCC__Mqtt5UserProp.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="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga60816fea14ab5afd0731cec1ddcfa92e" id="r_ga60816fea14ab5afd0731cec1ddcfa92e"><td class="memItemLeft" align="right" valign="top"><a id="ga60816fea14ab5afd0731cec1ddcfa92e" name="ga60816fea14ab5afd0731cec1ddcfa92e"></a>
#define </td><td class="memItemRight" valign="bottom"><b>CC_MQTT5_CLIENT_MAJOR_VERSION</b>   1U</td></tr>
<tr class="memdesc:ga60816fea14ab5afd0731cec1ddcfa92e"><td class="mdescLeft"> </td><td class="mdescRight">Major verion of the library. <br /></td></tr>
<tr class="separator:ga60816fea14ab5afd0731cec1ddcfa92e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae44dc5dfbccf359b5c84b62400d61225" id="r_gae44dc5dfbccf359b5c84b62400d61225"><td class="memItemLeft" align="right" valign="top"><a id="gae44dc5dfbccf359b5c84b62400d61225" name="gae44dc5dfbccf359b5c84b62400d61225"></a>
#define </td><td class="memItemRight" valign="bottom"><b>CC_MQTT5_CLIENT_MAKE_VERSION</b>(major_, minor_, patch_)</td></tr>
<tr class="memdesc:gae44dc5dfbccf359b5c84b62400d61225"><td class="mdescLeft"> </td><td class="mdescRight">Macro to create numeric version as single unsigned number. <br /></td></tr>
<tr class="separator:gae44dc5dfbccf359b5c84b62400d61225"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1725c46b37922b2e321f3b9b6fc58de9" id="r_ga1725c46b37922b2e321f3b9b6fc58de9"><td class="memItemLeft" align="right" valign="top"><a id="ga1725c46b37922b2e321f3b9b6fc58de9" name="ga1725c46b37922b2e321f3b9b6fc58de9"></a>
#define </td><td class="memItemRight" valign="bottom"><b>CC_MQTT5_CLIENT_MINOR_VERSION</b>   0U</td></tr>
<tr class="memdesc:ga1725c46b37922b2e321f3b9b6fc58de9"><td class="mdescLeft"> </td><td class="mdescRight">Minor verion of the library. <br /></td></tr>
<tr class="separator:ga1725c46b37922b2e321f3b9b6fc58de9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga197f1268575d85f3c08c4ee3e8dd1c9a" id="r_ga197f1268575d85f3c08c4ee3e8dd1c9a"><td class="memItemLeft" align="right" valign="top"><a id="ga197f1268575d85f3c08c4ee3e8dd1c9a" name="ga197f1268575d85f3c08c4ee3e8dd1c9a"></a>
#define </td><td class="memItemRight" valign="bottom"><b>CC_MQTT5_CLIENT_PATCH_VERSION</b>   1U</td></tr>
<tr class="memdesc:ga197f1268575d85f3c08c4ee3e8dd1c9a"><td class="mdescLeft"> </td><td class="mdescRight">Patch level of the library. <br /></td></tr>
<tr class="separator:ga197f1268575d85f3c08c4ee3e8dd1c9a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga529bb8056e83ffd5fe580b4c48e3f23a" id="r_ga529bb8056e83ffd5fe580b4c48e3f23a"><td class="memItemLeft" align="right" valign="top"><a id="ga529bb8056e83ffd5fe580b4c48e3f23a" name="ga529bb8056e83ffd5fe580b4c48e3f23a"></a>
#define </td><td class="memItemRight" valign="bottom"><b>CC_MQTT5_CLIENT_VERSION</b>   <a class="el" href="group__global.html#gae44dc5dfbccf359b5c84b62400d61225">CC_MQTT5_CLIENT_MAKE_VERSION</a>(<a class="el" href="group__global.html#ga60816fea14ab5afd0731cec1ddcfa92e">CC_MQTT5_CLIENT_MAJOR_VERSION</a>, <a class="el" href="group__global.html#ga1725c46b37922b2e321f3b9b6fc58de9">CC_MQTT5_CLIENT_MINOR_VERSION</a>, <a class="el" href="group__global.html#ga197f1268575d85f3c08c4ee3e8dd1c9a">CC_MQTT5_CLIENT_PATCH_VERSION</a>)</td></tr>
<tr class="memdesc:ga529bb8056e83ffd5fe580b4c48e3f23a"><td class="mdescLeft"> </td><td class="mdescRight">Version of the library as single numeric value. <br /></td></tr>
<tr class="separator:ga529bb8056e83ffd5fe580b4c48e3f23a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1e6d5384a535257d0ba8e2295870af09" id="r_ga1e6d5384a535257d0ba8e2295870af09"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__global.html#ga1e6d5384a535257d0ba8e2295870af09">CC_MQTT5_MAX_TOPIC_ALIASES_LIMIT</a>   0xffff</td></tr>
<tr class="memdesc:ga1e6d5384a535257d0ba8e2295870af09"><td class="mdescLeft"> </td><td class="mdescRight">MQTT5 protocol limit to topic alias. <br /></td></tr>
<tr class="separator:ga1e6d5384a535257d0ba8e2295870af09"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadec377b2331db0d470ef3789787ccbc8" id="r_gadec377b2331db0d470ef3789787ccbc8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__global.html#gadec377b2331db0d470ef3789787ccbc8">CC_MQTT5_SESSION_NEVER_EXPIRES</a>   0xffffffff</td></tr>
<tr class="memdesc:gadec377b2331db0d470ef3789787ccbc8"><td class="mdescLeft"> </td><td class="mdescRight">Special value for "Session Expiry Interval" property to specify that session never expires. <br /></td></tr>
<tr class="separator:gadec377b2331db0d470ef3789787ccbc8"><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:gabd56266bda747f19e4c6669fa0da021d" id="r_gabd56266bda747f19e4c6669fa0da021d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__global.html#gabd56266bda747f19e4c6669fa0da021d">CC_Mqtt5AsyncOpStatus</a> { <br />
  <a class="el" href="group__global.html#ggabd56266bda747f19e4c6669fa0da021da1612bd223303ddf181264c196d24855d">CC_Mqtt5AsyncOpStatus_Complete</a> = 0
, <a class="el" href="group__global.html#ggabd56266bda747f19e4c6669fa0da021da74d69b0e71d42515ba2e98bceb71f40b">CC_Mqtt5AsyncOpStatus_InternalError</a> = 1
, <a class="el" href="group__global.html#ggabd56266bda747f19e4c6669fa0da021da1a188d7ec8ccf7564fd680fd79a318eb">CC_Mqtt5AsyncOpStatus_Timeout</a> = 2
, <a class="el" href="group__global.html#ggabd56266bda747f19e4c6669fa0da021da071eb43b2ab5499d3bd753f083de10a7">CC_Mqtt5AsyncOpStatus_ProtocolError</a> = 3
, <br />
  <a class="el" href="group__global.html#ggabd56266bda747f19e4c6669fa0da021da805071d40ad1703c18988178c52804ff">CC_Mqtt5AsyncOpStatus_Aborted</a> = 4
, <a class="el" href="group__global.html#ggabd56266bda747f19e4c6669fa0da021da0f187c57434fb51740a8ecb4f8e97400">CC_Mqtt5AsyncOpStatus_BrokerDisconnected</a> = 5
, <a class="el" href="group__global.html#ggabd56266bda747f19e4c6669fa0da021daad8480a96239bd4133b44636acf1f0fc">CC_Mqtt5AsyncOpStatus_OutOfMemory</a> = 6
, <a class="el" href="group__global.html#ggabd56266bda747f19e4c6669fa0da021da15668e5d52308a87d84e7e7bcd8568fd">CC_Mqtt5AsyncOpStatus_BadParam</a> = 7
, <br />
  <a class="el" href="group__global.html#ggabd56266bda747f19e4c6669fa0da021da8844764d4adc59dbaf819524f4c4fa0f">CC_Mqtt5AsyncOpStatus_ValuesLimit</a>
<br />
}</td></tr>
<tr class="memdesc:gabd56266bda747f19e4c6669fa0da021d"><td class="mdescLeft"> </td><td class="mdescRight">Status of the asynchronous operation. <a href="group__global.html#gabd56266bda747f19e4c6669fa0da021d">More...</a><br /></td></tr>
<tr class="separator:gabd56266bda747f19e4c6669fa0da021d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa2b0e4ecc24bfd83703e722793a0bca1" id="r_gaa2b0e4ecc24bfd83703e722793a0bca1"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__global.html#gaa2b0e4ecc24bfd83703e722793a0bca1">CC_Mqtt5AuthErrorCode</a> { <a class="el" href="group__global.html#ggaa2b0e4ecc24bfd83703e722793a0bca1a73da94a53d477ad876e2a3133137fb30">CC_Mqtt5AuthErrorCode_Continue</a> = 0
, <a class="el" href="group__global.html#ggaa2b0e4ecc24bfd83703e722793a0bca1adea033704c194c4d575eee5d7f6c111f">CC_Mqtt5AuthErrorCode_Disconnect</a> = 1
, <a class="el" href="group__global.html#ggaa2b0e4ecc24bfd83703e722793a0bca1af434e93d01618c3010900b3a9bee9f20">CC_Mqtt5AuthErrorCode_ValuesLimit</a> = 2
}</td></tr>
<tr class="memdesc:gaa2b0e4ecc24bfd83703e722793a0bca1"><td class="mdescLeft"> </td><td class="mdescRight">Error code returned by the <a class="el" href="common_8h.html#a4763183da0cfbc4c0ec588d2ebf71430">CC_Mqtt5AuthCb</a> callback. <a href="group__global.html#gaa2b0e4ecc24bfd83703e722793a0bca1">More...</a><br /></td></tr>
<tr class="separator:gaa2b0e4ecc24bfd83703e722793a0bca1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gade2ba1fc06381168fc1c7c510a18bf41" id="r_gade2ba1fc06381168fc1c7c510a18bf41"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__global.html#gade2ba1fc06381168fc1c7c510a18bf41">CC_Mqtt5BrokerDisconnectReason</a> { <br />
  <a class="el" href="group__global.html#ggade2ba1fc06381168fc1c7c510a18bf41a09669579bbc2bdd5883000490e99668b">CC_Mqtt5BrokerDisconnectReason_DisconnectMsg</a> = 0
, <a class="el" href="group__global.html#ggade2ba1fc06381168fc1c7c510a18bf41ac2fea441ef0791b9e2dfb15060fc3ceb">CC_Mqtt5BrokerDisconnectReason_InternalError</a> = 1
, <a class="el" href="group__global.html#ggade2ba1fc06381168fc1c7c510a18bf41af272b98a8c132feb12382adf02b6aaae">CC_Mqtt5BrokerDisconnectReason_NoBrokerResponse</a> = 2
, <a class="el" href="group__global.html#ggade2ba1fc06381168fc1c7c510a18bf41a3a32928f5e30d2e41cc5bde681937790">CC_Mqtt5BrokerDisconnectReason_ProtocolError</a> = 3
, <br />
  <a class="el" href="group__global.html#ggade2ba1fc06381168fc1c7c510a18bf41a6c3c3a90cf76ad9a46684e04e0f3aea8">CC_Mqtt5BrokerDisconnectReason_ValuesLimit</a>
<br />
}</td></tr>
<tr class="memdesc:gade2ba1fc06381168fc1c7c510a18bf41"><td class="mdescLeft"> </td><td class="mdescRight">Reason for reporting unsolicited broker disconnection. <a href="group__global.html#gade2ba1fc06381168fc1c7c510a18bf41">More...</a><br /></td></tr>
<tr class="separator:gade2ba1fc06381168fc1c7c510a18bf41"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac9c64dc7d5a785e8b22d7faaaf6f9bea" id="r_gac9c64dc7d5a785e8b22d7faaaf6f9bea"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> { <br />
  <a class="el" href="group__global.html#ggac9c64dc7d5a785e8b22d7faaaf6f9beaa8f6454b1f4f259f82322e3b5517a4d63">CC_Mqtt5ErrorCode_Success</a> = 0
, <a class="el" href="group__global.html#ggac9c64dc7d5a785e8b22d7faaaf6f9beaad9fd7a1393b1854100ce3659aec37945">CC_Mqtt5ErrorCode_InternalError</a> = 1
, <a class="el" href="group__global.html#ggac9c64dc7d5a785e8b22d7faaaf6f9beaac1f19011141f4f86775348beca9c0db4">CC_Mqtt5ErrorCode_NotIntitialized</a> = 2
, <a class="el" href="group__global.html#ggac9c64dc7d5a785e8b22d7faaaf6f9beaaf0aff404a52da6b771ccf504b778dd43">CC_Mqtt5ErrorCode_Busy</a> = 3
, <br />
  <a class="el" href="group__global.html#ggac9c64dc7d5a785e8b22d7faaaf6f9beaa57c1dd09781de911c2cfc2d7b7bda725">CC_Mqtt5ErrorCode_NotConnected</a> = 4
, <a class="el" href="group__global.html#ggac9c64dc7d5a785e8b22d7faaaf6f9beaa59cc25768b679e2ee62a615dbb7186d6">CC_Mqtt5ErrorCode_AlreadyConnected</a> = 5
, <a class="el" href="group__global.html#ggac9c64dc7d5a785e8b22d7faaaf6f9beaa8614c000b8e812823b6ccf446eb09c94">CC_Mqtt5ErrorCode_BadParam</a> = 6
, <a class="el" href="group__global.html#ggac9c64dc7d5a785e8b22d7faaaf6f9beaa07556a61b1d42e67b2f3c704d787ac9e">CC_Mqtt5ErrorCode_InsufficientConfig</a> = 7
, <br />
  <a class="el" href="group__global.html#ggac9c64dc7d5a785e8b22d7faaaf6f9beaa4b5e8551359d9bc4daffd7d967f710eb">CC_Mqtt5ErrorCode_OutOfMemory</a> = 8
, <a class="el" href="group__global.html#ggac9c64dc7d5a785e8b22d7faaaf6f9beaab6fafd05b6bf24bc9aaf17bae80f3cb1">CC_Mqtt5ErrorCode_BufferOverflow</a> = 9
, <a class="el" href="group__global.html#ggac9c64dc7d5a785e8b22d7faaaf6f9beaab1b9e20d674c9a233e9bc36a1e3f5dfe">CC_Mqtt5ErrorCode_NotSupported</a> = 10
, <a class="el" href="group__global.html#ggac9c64dc7d5a785e8b22d7faaaf6f9beaaca485d14f9a067504a7ed21f2998747f">CC_Mqtt5ErrorCode_RetryLater</a> = 11
, <br />
  <a class="el" href="group__global.html#ggac9c64dc7d5a785e8b22d7faaaf6f9beaa411161d50d11f4ba3ef12b34f5319a70">CC_Mqtt5ErrorCode_Disconnecting</a> = 12
, <a class="el" href="group__global.html#ggac9c64dc7d5a785e8b22d7faaaf6f9beaab2dcbd4a84fdf4dd5c147fff6fbe62cc">CC_Mqtt5ErrorCode_NetworkDisconnected</a> = 13
, <a class="el" href="group__global.html#ggac9c64dc7d5a785e8b22d7faaaf6f9beaa95017579e8341ba51a551f4ef5277028">CC_Mqtt5ErrorCode_NotAuthenticated</a> = 14
, <a class="el" href="group__global.html#ggac9c64dc7d5a785e8b22d7faaaf6f9beaaff32d89715cd5675f31880083867dc46">CC_Mqtt5ErrorCode_PreparationLocked</a> = 15
, <br />
  <a class="el" href="group__global.html#ggac9c64dc7d5a785e8b22d7faaaf6f9beaaa15711e81f414283e9f9a43e42a0c87b">CC_Mqtt5ErrorCode_ValuesLimit</a>
<br />
}</td></tr>
<tr class="memdesc:gac9c64dc7d5a785e8b22d7faaaf6f9bea"><td class="mdescLeft"> </td><td class="mdescRight">Error code returned by various API functions. <a href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">More...</a><br /></td></tr>
<tr class="separator:gac9c64dc7d5a785e8b22d7faaaf6f9bea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga15e5d0f870e3f2afaeb44f5122e640d7" id="r_ga15e5d0f870e3f2afaeb44f5122e640d7"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__global.html#ga15e5d0f870e3f2afaeb44f5122e640d7">CC_Mqtt5PayloadFormat</a> { <a class="el" href="group__global.html#gga15e5d0f870e3f2afaeb44f5122e640d7a6b3fd41dbdd4cc9fcc27f530c4e86169">CC_Mqtt5PayloadFormat_Unspecified</a> = 0
, <a class="el" href="group__global.html#gga15e5d0f870e3f2afaeb44f5122e640d7ab9b4ffcbaf6e8dbed9d9f40af06e9fe1">CC_Mqtt5PayloadFormat_Utf8</a> = 1
, <a class="el" href="group__global.html#gga15e5d0f870e3f2afaeb44f5122e640d7ae69b7c032f97c524fe40ffc9cec0cdb4">CC_Mqtt5PayloadFormat_ValuesLimit</a>
}</td></tr>
<tr class="memdesc:ga15e5d0f870e3f2afaeb44f5122e640d7"><td class="mdescLeft"> </td><td class="mdescRight">Payload Format Indicator values as defined by the MQTT v5 protocol. <a href="group__global.html#ga15e5d0f870e3f2afaeb44f5122e640d7">More...</a><br /></td></tr>
<tr class="separator:ga15e5d0f870e3f2afaeb44f5122e640d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacfea3a318c3e2dd3d60c69a6a6157d7f" id="r_gacfea3a318c3e2dd3d60c69a6a6157d7f"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__global.html#gacfea3a318c3e2dd3d60c69a6a6157d7f">CC_Mqtt5QoS</a> { <a class="el" href="group__global.html#ggacfea3a318c3e2dd3d60c69a6a6157d7fa371c4d68d2d2c2ce9bd07927b22596fb">CC_Mqtt5QoS_AtMostOnceDelivery</a> = 0
, <a class="el" href="group__global.html#ggacfea3a318c3e2dd3d60c69a6a6157d7fa7177e192e6dd58b2eae3b78eb671eec5">CC_Mqtt5QoS_AtLeastOnceDelivery</a> = 1
, <a class="el" href="group__global.html#ggacfea3a318c3e2dd3d60c69a6a6157d7fa13430f9f8356378d2e493b1c0d1fface">CC_Mqtt5QoS_ExactlyOnceDelivery</a> = 2
, <a class="el" href="group__global.html#ggacfea3a318c3e2dd3d60c69a6a6157d7fa35f9dd2e8f9557e891d89342de845c9b">CC_Mqtt5QoS_ValuesLimit</a>
}</td></tr>
<tr class="memdesc:gacfea3a318c3e2dd3d60c69a6a6157d7f"><td class="mdescLeft"> </td><td class="mdescRight">Quality of Service. <a href="group__global.html#gacfea3a318c3e2dd3d60c69a6a6157d7f">More...</a><br /></td></tr>
<tr class="separator:gacfea3a318c3e2dd3d60c69a6a6157d7f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7231ab939f4dd41f18a27ed953fda977" id="r_ga7231ab939f4dd41f18a27ed953fda977"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__global.html#ga7231ab939f4dd41f18a27ed953fda977">CC_Mqtt5ReasonCode</a> { <br />
  <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977aa1cb657ae4ad8917b3a8f1fda2b60e4a">CC_Mqtt5ReasonCode_Success</a> = 0
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a456175e5b17eb852b3c35e71536e954e">CC_Mqtt5ReasonCode_NormalDisconnection</a> = 0
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a85f91f1c1d7a798625977c479fb0f704">CC_Mqtt5ReasonCode_GrantedQos0</a> = 0
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977ad85e0109bceb699ba11fa68cb08f45b0">CC_Mqtt5ReasonCode_GrantedQos1</a> = 1
, <br />
  <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a1253860858b11d39d65754b71a832d9c">CC_Mqtt5ReasonCode_GrantedQos2</a> = 2
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977ad9553e1ccbc0520aade4221743514dc9">CC_Mqtt5ReasonCode_DisconnectWithWill</a> = 4
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a1078165624077c2723dff09a84cd5652">CC_Mqtt5ReasonCode_NoMatchingSubscribers</a> = 16
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a662bc3de350a524d22c1af3b2b795dc1">CC_Mqtt5ReasonCode_NoSubscriptionExisted</a> = 17
, <br />
  <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977af7899bba6fb6fa4b53a13f5e07617637">CC_Mqtt5ReasonCode_ContinueAuth</a> = 24
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a4237b2d4b62a76ba02291244dbc600d2">CC_Mqtt5ReasonCode_ReAuth</a> = 25
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977af6b53fd67e10ddb82f83106298405dfe">CC_Mqtt5ReasonCode_UnspecifiedError</a> = 128
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a932284765850a2360f8ddc1c6a6dfedd">CC_Mqtt5ReasonCode_MalformedPacket</a> = 129
, <br />
  <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977aff391bcd9771b806c620a51b111035f6">CC_Mqtt5ReasonCode_ProtocolError</a> = 130
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a17031050699fba90c4c7b322d66c7cba">CC_Mqtt5ReasonCode_ImplSpecificError</a> = 131
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a2132fc8d895de84882826a8d2117736a">CC_Mqtt5ReasonCode_UnsupportedVersion</a> = 132
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977af5a71e2c63d7eacaa29367ce093717c0">CC_Mqtt5ReasonCode_ClientIdInvalid</a> = 133
, <br />
  <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977ae2b11eb7d501b89d75cd979f8e95bd11">CC_Mqtt5ReasonCode_BadUserPassword</a> = 134
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977ab0fd71f545d4c2caf09d07ab6013ed49">CC_Mqtt5ReasonCode_NotAuthorized</a> = 135
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a798f4cd053ff09f771dbd5aec7d10c08">CC_Mqtt5ReasonCode_ServerUnavailable</a> = 136
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a599677fed83fff7e8a69af5738043cbb">CC_Mqtt5ReasonCode_ServerBusy</a> = 137
, <br />
  <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977aceb561a5b7d47bd1f954af1c90eedb6e">CC_Mqtt5ReasonCode_Banned</a> = 138
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977ab733351385f69bc115d48434a65bad2f">CC_Mqtt5ReasonCode_ServerShuttingDown</a> = 139
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977ab9295296798cc87d65310a2d54302bee">CC_Mqtt5ReasonCode_BadAuthMethod</a> = 140
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a7970a93eaa2dd8e663814eb1ebb0ca9f">CC_Mqtt5ReasonCode_KeepAliveTimeout</a> = 141
, <br />
  <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a0b82452f4e85fe0fe2fefdbfcebc7805">CC_Mqtt5ReasonCode_SessionTakenOver</a> = 142
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a8c989ce5a3f1cfd1834aec410358e67f">CC_Mqtt5ReasonCode_TopicFilterInvalid</a> = 143
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a5a294009d94b2769c99c36964d4a0572">CC_Mqtt5ReasonCode_TopicNameInvalid</a> = 144
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a940656172e48556f035a0cabb6fc7ddc">CC_Mqtt5ReasonCode_PacketIdInUse</a> = 145
, <br />
  <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977ad0ba663908b1b296791b50b3d03a4f56">CC_Mqtt5ReasonCode_PacketIdNotFound</a> = 146
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a7ece1b58b9f13e4bfd1dcdbd2e84a9c2">CC_Mqtt5ReasonCode_ReceiveMaxExceeded</a> = 147
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977aea6dddbacf8a55fb6faf6421f81ed358">CC_Mqtt5ReasonCode_TopicAliasInvalid</a> = 148
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a8750201c93870e06e4f6a80b16a1316a">CC_Mqtt5ReasonCode_PacketTooLarge</a> = 149
, <br />
  <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977aeabe01a8f692181390143cf0414dbbcb">CC_Mqtt5ReasonCode_MsgRateTooHigh</a> = 150
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a505ed2f9313c15fbe91712ef938b772f">CC_Mqtt5ReasonCode_QuotaExceeded</a> = 151
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977ab9240bcf5264aae6de967238cd46fe10">CC_Mqtt5ReasonCode_AdministrativeAction</a> = 152
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a5af271ee0ea03034741ec2fb61fe054e">CC_Mqtt5ReasonCode_PayloadFormatInvalid</a> = 153
, <br />
  <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a76b5dd23f84b2a633de8b896c9024a92">CC_Mqtt5ReasonCode_RetainNotSupported</a> = 154
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a6905fac7da49ca63fda2c036489552c8">CC_Mqtt5ReasonCode_QosNotSupported</a> = 155
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a89f2853bf29f7591d6b3c9f48a74ef9c">CC_Mqtt5ReasonCode_UseAnotherServer</a> = 156
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a233720c34dfe73d2e963675819c303c2">CC_Mqtt5ReasonCode_ServerMoved</a> = 157
, <br />
  <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977ab6fd643623076c3a4acaad09c527644a">CC_Mqtt5ReasonCode_SharedSubNotSuppored</a> = 158
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a72fd02c98e3799a590cdc69985912374">CC_Mqtt5ReasonCode_ConnectionRateExceeded</a> = 159
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a71cba998880657f2f083e7a8345e412d">CC_Mqtt5ReasonCode_MaxConnectTime</a> = 160
, <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977a3bf10f878858aa4edf9e9de468fea50e">CC_Mqtt5ReasonCode_SubIdsNotSupported</a> = 161
, <br />
  <a class="el" href="group__global.html#gga7231ab939f4dd41f18a27ed953fda977adc5c7609d381d5dd1a82963f53b8ff15">CC_Mqtt5ReasonCode_WildcardSubsNotSupported</a> = 162
<br />
}</td></tr>
<tr class="memdesc:ga7231ab939f4dd41f18a27ed953fda977"><td class="mdescLeft"> </td><td class="mdescRight">"Reason Code" as defined in MQTT v5 specification <a href="group__global.html#ga7231ab939f4dd41f18a27ed953fda977">More...</a><br /></td></tr>
<tr class="separator:ga7231ab939f4dd41f18a27ed953fda977"><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:ga17b1578d844c75274357e5b9f23f3ace" id="r_ga17b1578d844c75274357e5b9f23f3ace"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__global.html#ga17b1578d844c75274357e5b9f23f3ace">cc_mqtt5_client_init_user_prop</a> (<a class="el" href="structCC__Mqtt5UserProp.html">CC_Mqtt5UserProp</a> *prop)</td></tr>
<tr class="memdesc:ga17b1578d844c75274357e5b9f23f3ace"><td class="mdescLeft"> </td><td class="mdescRight">Intialize the <a class="el" href="structCC__Mqtt5UserProp.html">CC_Mqtt5UserProp</a> structure. <br /></td></tr>
<tr class="separator:ga17b1578d844c75274357e5b9f23f3ace"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga1e6d5384a535257d0ba8e2295870af09" name="ga1e6d5384a535257d0ba8e2295870af09"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1e6d5384a535257d0ba8e2295870af09">◆ </a></span>CC_MQTT5_MAX_TOPIC_ALIASES_LIMIT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CC_MQTT5_MAX_TOPIC_ALIASES_LIMIT   0xffff</td>
</tr>
</table>
</div><div class="memdoc">
<p>MQTT5 protocol limit to topic alias. </p>
<p>The application is expected not to allocate more than 65535 topic aliases. </p>
</div>
</div>
<a id="gadec377b2331db0d470ef3789787ccbc8" name="gadec377b2331db0d470ef3789787ccbc8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadec377b2331db0d470ef3789787ccbc8">◆ </a></span>CC_MQTT5_SESSION_NEVER_EXPIRES</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CC_MQTT5_SESSION_NEVER_EXPIRES   0xffffffff</td>
</tr>
</table>
</div><div class="memdoc">
<p>Special value for "Session Expiry Interval" property to specify that session never expires. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structCC__Mqtt5ConnectExtraConfig.html#af473dd3f19fd748259f35297e4e75fb1">CC_Mqtt5ConnectExtraConfig::m_sessionExpiryInterval</a> </dd>
<dd>
<a class="el" href="structCC__Mqtt5ConnectResponse.html#aaae295664d42a8107a3e4518e6b32caf">CC_Mqtt5ConnectResponse::m_sessionExpiryInterval</a> </dd></dl>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="gabd56266bda747f19e4c6669fa0da021d" name="gabd56266bda747f19e4c6669fa0da021d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabd56266bda747f19e4c6669fa0da021d">◆ </a></span>CC_Mqtt5AsyncOpStatus</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__global.html#gabd56266bda747f19e4c6669fa0da021d">CC_Mqtt5AsyncOpStatus</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Status of the asynchronous operation. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggabd56266bda747f19e4c6669fa0da021da1612bd223303ddf181264c196d24855d" name="ggabd56266bda747f19e4c6669fa0da021da1612bd223303ddf181264c196d24855d"></a>CC_Mqtt5AsyncOpStatus_Complete </td><td class="fielddoc"><p>The requested operation has been completed, refer to reported extra details for information. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggabd56266bda747f19e4c6669fa0da021da74d69b0e71d42515ba2e98bceb71f40b" name="ggabd56266bda747f19e4c6669fa0da021da74d69b0e71d42515ba2e98bceb71f40b"></a>CC_Mqtt5AsyncOpStatus_InternalError </td><td class="fielddoc"><p>Internal library error, please submit bug report <br />
</p>
</td></tr>
<tr><td class="fieldname"><a id="ggabd56266bda747f19e4c6669fa0da021da1a188d7ec8ccf7564fd680fd79a318eb" name="ggabd56266bda747f19e4c6669fa0da021da1a188d7ec8ccf7564fd680fd79a318eb"></a>CC_Mqtt5AsyncOpStatus_Timeout </td><td class="fielddoc"><p>The required response from broker hasn't been received in time. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggabd56266bda747f19e4c6669fa0da021da071eb43b2ab5499d3bd753f083de10a7" name="ggabd56266bda747f19e4c6669fa0da021da071eb43b2ab5499d3bd753f083de10a7"></a>CC_Mqtt5AsyncOpStatus_ProtocolError </td><td class="fielddoc"><p>The broker's response doesn't comply with MQTT5 specification. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggabd56266bda747f19e4c6669fa0da021da805071d40ad1703c18988178c52804ff" name="ggabd56266bda747f19e4c6669fa0da021da805071d40ad1703c18988178c52804ff"></a>CC_Mqtt5AsyncOpStatus_Aborted </td><td class="fielddoc"><p>The operation has been aborted before completion due to client's side operation. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggabd56266bda747f19e4c6669fa0da021da0f187c57434fb51740a8ecb4f8e97400" name="ggabd56266bda747f19e4c6669fa0da021da0f187c57434fb51740a8ecb4f8e97400"></a>CC_Mqtt5AsyncOpStatus_BrokerDisconnected </td><td class="fielddoc"><p>The operation has been aborted before completion due to broker's disconnection. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggabd56266bda747f19e4c6669fa0da021daad8480a96239bd4133b44636acf1f0fc" name="ggabd56266bda747f19e4c6669fa0da021daad8480a96239bd4133b44636acf1f0fc"></a>CC_Mqtt5AsyncOpStatus_OutOfMemory </td><td class="fielddoc"><p>The client library wasn't able to allocate necessary memory. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggabd56266bda747f19e4c6669fa0da021da15668e5d52308a87d84e7e7bcd8568fd" name="ggabd56266bda747f19e4c6669fa0da021da15668e5d52308a87d84e7e7bcd8568fd"></a>CC_Mqtt5AsyncOpStatus_BadParam </td><td class="fielddoc"><p>Bad value has been returned from the relevant callback. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggabd56266bda747f19e4c6669fa0da021da8844764d4adc59dbaf819524f4c4fa0f" name="ggabd56266bda747f19e4c6669fa0da021da8844764d4adc59dbaf819524f4c4fa0f"></a>CC_Mqtt5AsyncOpStatus_ValuesLimit </td><td class="fielddoc"><p>Limit for the values. </p>
</td></tr>
</table>
</div>
</div>
<a id="gaa2b0e4ecc24bfd83703e722793a0bca1" name="gaa2b0e4ecc24bfd83703e722793a0bca1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa2b0e4ecc24bfd83703e722793a0bca1">◆ </a></span>CC_Mqtt5AuthErrorCode</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__global.html#gaa2b0e4ecc24bfd83703e722793a0bca1">CC_Mqtt5AuthErrorCode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Error code returned by the <a class="el" href="common_8h.html#a4763183da0cfbc4c0ec588d2ebf71430">CC_Mqtt5AuthCb</a> callback. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggaa2b0e4ecc24bfd83703e722793a0bca1a73da94a53d477ad876e2a3133137fb30" name="ggaa2b0e4ecc24bfd83703e722793a0bca1a73da94a53d477ad876e2a3133137fb30"></a>CC_Mqtt5AuthErrorCode_Continue </td><td class="fielddoc"><p>Continue the authentication process. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa2b0e4ecc24bfd83703e722793a0bca1adea033704c194c4d575eee5d7f6c111f" name="ggaa2b0e4ecc24bfd83703e722793a0bca1adea033704c194c4d575eee5d7f6c111f"></a>CC_Mqtt5AuthErrorCode_Disconnect </td><td class="fielddoc"><p>Stop the authentication, send DISCONNECT to broker. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa2b0e4ecc24bfd83703e722793a0bca1af434e93d01618c3010900b3a9bee9f20" name="ggaa2b0e4ecc24bfd83703e722793a0bca1af434e93d01618c3010900b3a9bee9f20"></a>CC_Mqtt5AuthErrorCode_ValuesLimit </td><td class="fielddoc"><p>Limit for the values. </p>
</td></tr>
</table>
</div>
</div>
<a id="gade2ba1fc06381168fc1c7c510a18bf41" name="gade2ba1fc06381168fc1c7c510a18bf41"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gade2ba1fc06381168fc1c7c510a18bf41">◆ </a></span>CC_Mqtt5BrokerDisconnectReason</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__global.html#gade2ba1fc06381168fc1c7c510a18bf41">CC_Mqtt5BrokerDisconnectReason</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reason for reporting unsolicited broker disconnection. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggade2ba1fc06381168fc1c7c510a18bf41a09669579bbc2bdd5883000490e99668b" name="ggade2ba1fc06381168fc1c7c510a18bf41a09669579bbc2bdd5883000490e99668b"></a>CC_Mqtt5BrokerDisconnectReason_DisconnectMsg </td><td class="fielddoc"><p>The broker sent <b>DISCONNECT</b> message. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggade2ba1fc06381168fc1c7c510a18bf41ac2fea441ef0791b9e2dfb15060fc3ceb" name="ggade2ba1fc06381168fc1c7c510a18bf41ac2fea441ef0791b9e2dfb15060fc3ceb"></a>CC_Mqtt5BrokerDisconnectReason_InternalError </td><td class="fielddoc"><p>The library encountered internal error and there is a need to close network connection. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggade2ba1fc06381168fc1c7c510a18bf41af272b98a8c132feb12382adf02b6aaae" name="ggade2ba1fc06381168fc1c7c510a18bf41af272b98a8c132feb12382adf02b6aaae"></a>CC_Mqtt5BrokerDisconnectReason_NoBrokerResponse </td><td class="fielddoc"><p>No messages from the broker and no response to <b>PINGREQ</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggade2ba1fc06381168fc1c7c510a18bf41a3a32928f5e30d2e41cc5bde681937790" name="ggade2ba1fc06381168fc1c7c510a18bf41a3a32928f5e30d2e41cc5bde681937790"></a>CC_Mqtt5BrokerDisconnectReason_ProtocolError </td><td class="fielddoc"><p>Protocol error was detected. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggade2ba1fc06381168fc1c7c510a18bf41a6c3c3a90cf76ad9a46684e04e0f3aea8" name="ggade2ba1fc06381168fc1c7c510a18bf41a6c3c3a90cf76ad9a46684e04e0f3aea8"></a>CC_Mqtt5BrokerDisconnectReason_ValuesLimit </td><td class="fielddoc"><p>Limit for the values. </p>
</td></tr>
</table>
</div>
</div>
<a id="gac9c64dc7d5a785e8b22d7faaaf6f9bea" name="gac9c64dc7d5a785e8b22d7faaaf6f9bea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac9c64dc7d5a785e8b22d7faaaf6f9bea">◆ </a></span>CC_Mqtt5ErrorCode</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Error code returned by various API functions. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggac9c64dc7d5a785e8b22d7faaaf6f9beaa8f6454b1f4f259f82322e3b5517a4d63" name="ggac9c64dc7d5a785e8b22d7faaaf6f9beaa8f6454b1f4f259f82322e3b5517a4d63"></a>CC_Mqtt5ErrorCode_Success </td><td class="fielddoc"><p>The requested function executed successfully. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac9c64dc7d5a785e8b22d7faaaf6f9beaad9fd7a1393b1854100ce3659aec37945" name="ggac9c64dc7d5a785e8b22d7faaaf6f9beaad9fd7a1393b1854100ce3659aec37945"></a>CC_Mqtt5ErrorCode_InternalError </td><td class="fielddoc"><p>Internal library error, please submit bug report <br />
</p>
</td></tr>
<tr><td class="fieldname"><a id="ggac9c64dc7d5a785e8b22d7faaaf6f9beaac1f19011141f4f86775348beca9c0db4" name="ggac9c64dc7d5a785e8b22d7faaaf6f9beaac1f19011141f4f86775348beca9c0db4"></a>CC_Mqtt5ErrorCode_NotIntitialized </td><td class="fielddoc"><p>The allocated client hasn't been initialized. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac9c64dc7d5a785e8b22d7faaaf6f9beaaf0aff404a52da6b771ccf504b778dd43" name="ggac9c64dc7d5a785e8b22d7faaaf6f9beaaf0aff404a52da6b771ccf504b778dd43"></a>CC_Mqtt5ErrorCode_Busy </td><td class="fielddoc"><p>The client library is in the middle of previous operation(s), cannot start a new one. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac9c64dc7d5a785e8b22d7faaaf6f9beaa57c1dd09781de911c2cfc2d7b7bda725" name="ggac9c64dc7d5a785e8b22d7faaaf6f9beaa57c1dd09781de911c2cfc2d7b7bda725"></a>CC_Mqtt5ErrorCode_NotConnected </td><td class="fielddoc"><p>The client library is not connected to the broker. Returned by operations that require connection to the broker. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac9c64dc7d5a785e8b22d7faaaf6f9beaa59cc25768b679e2ee62a615dbb7186d6" name="ggac9c64dc7d5a785e8b22d7faaaf6f9beaa59cc25768b679e2ee62a615dbb7186d6"></a>CC_Mqtt5ErrorCode_AlreadyConnected </td><td class="fielddoc"><p>The client library is already connected to the broker, cannot perform connection operation. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac9c64dc7d5a785e8b22d7faaaf6f9beaa8614c000b8e812823b6ccf446eb09c94" name="ggac9c64dc7d5a785e8b22d7faaaf6f9beaa8614c000b8e812823b6ccf446eb09c94"></a>CC_Mqtt5ErrorCode_BadParam </td><td class="fielddoc"><p>Bad parameter is passed to the function. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac9c64dc7d5a785e8b22d7faaaf6f9beaa07556a61b1d42e67b2f3c704d787ac9e" name="ggac9c64dc7d5a785e8b22d7faaaf6f9beaa07556a61b1d42e67b2f3c704d787ac9e"></a>CC_Mqtt5ErrorCode_InsufficientConfig </td><td class="fielddoc"><p>The required configuration hasn't been performed. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac9c64dc7d5a785e8b22d7faaaf6f9beaa4b5e8551359d9bc4daffd7d967f710eb" name="ggac9c64dc7d5a785e8b22d7faaaf6f9beaa4b5e8551359d9bc4daffd7d967f710eb"></a>CC_Mqtt5ErrorCode_OutOfMemory </td><td class="fielddoc"><p>Memory allocation failed. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac9c64dc7d5a785e8b22d7faaaf6f9beaab6fafd05b6bf24bc9aaf17bae80f3cb1" name="ggac9c64dc7d5a785e8b22d7faaaf6f9beaab6fafd05b6bf24bc9aaf17bae80f3cb1"></a>CC_Mqtt5ErrorCode_BufferOverflow </td><td class="fielddoc"><p>Output buffer is too short. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac9c64dc7d5a785e8b22d7faaaf6f9beaab1b9e20d674c9a233e9bc36a1e3f5dfe" name="ggac9c64dc7d5a785e8b22d7faaaf6f9beaab1b9e20d674c9a233e9bc36a1e3f5dfe"></a>CC_Mqtt5ErrorCode_NotSupported </td><td class="fielddoc"><p>Feature is not supported. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac9c64dc7d5a785e8b22d7faaaf6f9beaaca485d14f9a067504a7ed21f2998747f" name="ggac9c64dc7d5a785e8b22d7faaaf6f9beaaca485d14f9a067504a7ed21f2998747f"></a>CC_Mqtt5ErrorCode_RetryLater </td><td class="fielddoc"><p>Retry in next event loop iteration. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac9c64dc7d5a785e8b22d7faaaf6f9beaa411161d50d11f4ba3ef12b34f5319a70" name="ggac9c64dc7d5a785e8b22d7faaaf6f9beaa411161d50d11f4ba3ef12b34f5319a70"></a>CC_Mqtt5ErrorCode_Disconnecting </td><td class="fielddoc"><p>The client is in "disconnecting" state, (re)connect is required in the next iteration loop. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac9c64dc7d5a785e8b22d7faaaf6f9beaab2dcbd4a84fdf4dd5c147fff6fbe62cc" name="ggac9c64dc7d5a785e8b22d7faaaf6f9beaab2dcbd4a84fdf4dd5c147fff6fbe62cc"></a>CC_Mqtt5ErrorCode_NetworkDisconnected </td><td class="fielddoc"><p>When network is disconnected issueing new ops is not accepted. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac9c64dc7d5a785e8b22d7faaaf6f9beaa95017579e8341ba51a551f4ef5277028" name="ggac9c64dc7d5a785e8b22d7faaaf6f9beaa95017579e8341ba51a551f4ef5277028"></a>CC_Mqtt5ErrorCode_NotAuthenticated </td><td class="fielddoc"><p>The client not authenticated. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac9c64dc7d5a785e8b22d7faaaf6f9beaaff32d89715cd5675f31880083867dc46" name="ggac9c64dc7d5a785e8b22d7faaaf6f9beaaff32d89715cd5675f31880083867dc46"></a>CC_Mqtt5ErrorCode_PreparationLocked </td><td class="fielddoc"><p>Another operation is being prepared, cannot create a new one without performing "send" or "cancel". </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac9c64dc7d5a785e8b22d7faaaf6f9beaaa15711e81f414283e9f9a43e42a0c87b" name="ggac9c64dc7d5a785e8b22d7faaaf6f9beaaa15711e81f414283e9f9a43e42a0c87b"></a>CC_Mqtt5ErrorCode_ValuesLimit </td><td class="fielddoc"><p>Limit for the values. </p>
</td></tr>
</table>
</div>
</div>
<a id="ga15e5d0f870e3f2afaeb44f5122e640d7" name="ga15e5d0f870e3f2afaeb44f5122e640d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga15e5d0f870e3f2afaeb44f5122e640d7">◆ </a></span>CC_Mqtt5PayloadFormat</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__global.html#ga15e5d0f870e3f2afaeb44f5122e640d7">CC_Mqtt5PayloadFormat</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Payload Format Indicator values as defined by the MQTT v5 protocol. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga15e5d0f870e3f2afaeb44f5122e640d7a6b3fd41dbdd4cc9fcc27f530c4e86169" name="gga15e5d0f870e3f2afaeb44f5122e640d7a6b3fd41dbdd4cc9fcc27f530c4e86169"></a>CC_Mqtt5PayloadFormat_Unspecified </td><td class="fielddoc"><p>Unspecified format. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga15e5d0f870e3f2afaeb44f5122e640d7ab9b4ffcbaf6e8dbed9d9f40af06e9fe1" name="gga15e5d0f870e3f2afaeb44f5122e640d7ab9b4ffcbaf6e8dbed9d9f40af06e9fe1"></a>CC_Mqtt5PayloadFormat_Utf8 </td><td class="fielddoc"><p>UTF-8 string. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga15e5d0f870e3f2afaeb44f5122e640d7ae69b7c032f97c524fe40ffc9cec0cdb4" name="gga15e5d0f870e3f2afaeb44f5122e640d7ae69b7c032f97c524fe40ffc9cec0cdb4"></a>CC_Mqtt5PayloadFormat_ValuesLimit </td><td class="fielddoc"><p>Limit of the values. </p>
</td></tr>
</table>
</div>
</div>
<a id="gacfea3a318c3e2dd3d60c69a6a6157d7f" name="gacfea3a318c3e2dd3d60c69a6a6157d7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacfea3a318c3e2dd3d60c69a6a6157d7f">◆ </a></span>CC_Mqtt5QoS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__global.html#gacfea3a318c3e2dd3d60c69a6a6157d7f">CC_Mqtt5QoS</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Quality of Service. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggacfea3a318c3e2dd3d60c69a6a6157d7fa371c4d68d2d2c2ce9bd07927b22596fb" name="ggacfea3a318c3e2dd3d60c69a6a6157d7fa371c4d68d2d2c2ce9bd07927b22596fb"></a>CC_Mqtt5QoS_AtMostOnceDelivery </td><td class="fielddoc"><p>QoS=0. At most once delivery. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggacfea3a318c3e2dd3d60c69a6a6157d7fa7177e192e6dd58b2eae3b78eb671eec5" name="ggacfea3a318c3e2dd3d60c69a6a6157d7fa7177e192e6dd58b2eae3b78eb671eec5"></a>CC_Mqtt5QoS_AtLeastOnceDelivery </td><td class="fielddoc"><p>QoS=1. At least once delivery. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggacfea3a318c3e2dd3d60c69a6a6157d7fa13430f9f8356378d2e493b1c0d1fface" name="ggacfea3a318c3e2dd3d60c69a6a6157d7fa13430f9f8356378d2e493b1c0d1fface"></a>CC_Mqtt5QoS_ExactlyOnceDelivery </td><td class="fielddoc"><p>QoS=2. Exactly once delivery. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggacfea3a318c3e2dd3d60c69a6a6157d7fa35f9dd2e8f9557e891d89342de845c9b" name="ggacfea3a318c3e2dd3d60c69a6a6157d7fa35f9dd2e8f9557e891d89342de845c9b"></a>CC_Mqtt5QoS_ValuesLimit </td><td class="fielddoc"><p>Limit for the values. </p>
</td></tr>
</table>
</div>
</div>
<a id="ga7231ab939f4dd41f18a27ed953fda977" name="ga7231ab939f4dd41f18a27ed953fda977"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7231ab939f4dd41f18a27ed953fda977">◆ </a></span>CC_Mqtt5ReasonCode</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__global.html#ga7231ab939f4dd41f18a27ed953fda977">CC_Mqtt5ReasonCode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>"Reason Code" as defined in MQTT v5 specification </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977aa1cb657ae4ad8917b3a8f1fda2b60e4a" name="gga7231ab939f4dd41f18a27ed953fda977aa1cb657ae4ad8917b3a8f1fda2b60e4a"></a>CC_Mqtt5ReasonCode_Success </td><td class="fielddoc"><p>value <b>Success</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a456175e5b17eb852b3c35e71536e954e" name="gga7231ab939f4dd41f18a27ed953fda977a456175e5b17eb852b3c35e71536e954e"></a>CC_Mqtt5ReasonCode_NormalDisconnection </td><td class="fielddoc"><p>value <b>Normal Disconnection</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a85f91f1c1d7a798625977c479fb0f704" name="gga7231ab939f4dd41f18a27ed953fda977a85f91f1c1d7a798625977c479fb0f704"></a>CC_Mqtt5ReasonCode_GrantedQos0 </td><td class="fielddoc"><p>value <b>Granted QoS0</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977ad85e0109bceb699ba11fa68cb08f45b0" name="gga7231ab939f4dd41f18a27ed953fda977ad85e0109bceb699ba11fa68cb08f45b0"></a>CC_Mqtt5ReasonCode_GrantedQos1 </td><td class="fielddoc"><p>value <b>Granted QoS1</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a1253860858b11d39d65754b71a832d9c" name="gga7231ab939f4dd41f18a27ed953fda977a1253860858b11d39d65754b71a832d9c"></a>CC_Mqtt5ReasonCode_GrantedQos2 </td><td class="fielddoc"><p>value <b>Granted QoS2</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977ad9553e1ccbc0520aade4221743514dc9" name="gga7231ab939f4dd41f18a27ed953fda977ad9553e1ccbc0520aade4221743514dc9"></a>CC_Mqtt5ReasonCode_DisconnectWithWill </td><td class="fielddoc"><p>value <b>Disconnect w/ Will</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a1078165624077c2723dff09a84cd5652" name="gga7231ab939f4dd41f18a27ed953fda977a1078165624077c2723dff09a84cd5652"></a>CC_Mqtt5ReasonCode_NoMatchingSubscribers </td><td class="fielddoc"><p>value <b>No Matching Subscribers</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a662bc3de350a524d22c1af3b2b795dc1" name="gga7231ab939f4dd41f18a27ed953fda977a662bc3de350a524d22c1af3b2b795dc1"></a>CC_Mqtt5ReasonCode_NoSubscriptionExisted </td><td class="fielddoc"><p>value <b>No Subscription Existed</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977af7899bba6fb6fa4b53a13f5e07617637" name="gga7231ab939f4dd41f18a27ed953fda977af7899bba6fb6fa4b53a13f5e07617637"></a>CC_Mqtt5ReasonCode_ContinueAuth </td><td class="fielddoc"><p>value <b>Continue authentication</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a4237b2d4b62a76ba02291244dbc600d2" name="gga7231ab939f4dd41f18a27ed953fda977a4237b2d4b62a76ba02291244dbc600d2"></a>CC_Mqtt5ReasonCode_ReAuth </td><td class="fielddoc"><p>value <b>Re-authenticate</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977af6b53fd67e10ddb82f83106298405dfe" name="gga7231ab939f4dd41f18a27ed953fda977af6b53fd67e10ddb82f83106298405dfe"></a>CC_Mqtt5ReasonCode_UnspecifiedError </td><td class="fielddoc"><p>value <b>Unspecified error</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a932284765850a2360f8ddc1c6a6dfedd" name="gga7231ab939f4dd41f18a27ed953fda977a932284765850a2360f8ddc1c6a6dfedd"></a>CC_Mqtt5ReasonCode_MalformedPacket </td><td class="fielddoc"><p>value <b>Malformed Packet</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977aff391bcd9771b806c620a51b111035f6" name="gga7231ab939f4dd41f18a27ed953fda977aff391bcd9771b806c620a51b111035f6"></a>CC_Mqtt5ReasonCode_ProtocolError </td><td class="fielddoc"><p>value <b>Protocol Error</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a17031050699fba90c4c7b322d66c7cba" name="gga7231ab939f4dd41f18a27ed953fda977a17031050699fba90c4c7b322d66c7cba"></a>CC_Mqtt5ReasonCode_ImplSpecificError </td><td class="fielddoc"><p>value <b>Impl. Specific Error</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a2132fc8d895de84882826a8d2117736a" name="gga7231ab939f4dd41f18a27ed953fda977a2132fc8d895de84882826a8d2117736a"></a>CC_Mqtt5ReasonCode_UnsupportedVersion </td><td class="fielddoc"><p>value <b>Unsupported Version</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977af5a71e2c63d7eacaa29367ce093717c0" name="gga7231ab939f4dd41f18a27ed953fda977af5a71e2c63d7eacaa29367ce093717c0"></a>CC_Mqtt5ReasonCode_ClientIdInvalid </td><td class="fielddoc"><p>value <b>Client ID Invalid</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977ae2b11eb7d501b89d75cd979f8e95bd11" name="gga7231ab939f4dd41f18a27ed953fda977ae2b11eb7d501b89d75cd979f8e95bd11"></a>CC_Mqtt5ReasonCode_BadUserPassword </td><td class="fielddoc"><p>value <b>Bad Username/Password</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977ab0fd71f545d4c2caf09d07ab6013ed49" name="gga7231ab939f4dd41f18a27ed953fda977ab0fd71f545d4c2caf09d07ab6013ed49"></a>CC_Mqtt5ReasonCode_NotAuthorized </td><td class="fielddoc"><p>value <b>Not authorized</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a798f4cd053ff09f771dbd5aec7d10c08" name="gga7231ab939f4dd41f18a27ed953fda977a798f4cd053ff09f771dbd5aec7d10c08"></a>CC_Mqtt5ReasonCode_ServerUnavailable </td><td class="fielddoc"><p>value <b>Server unavailable</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a599677fed83fff7e8a69af5738043cbb" name="gga7231ab939f4dd41f18a27ed953fda977a599677fed83fff7e8a69af5738043cbb"></a>CC_Mqtt5ReasonCode_ServerBusy </td><td class="fielddoc"><p>value <b>Server busy</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977aceb561a5b7d47bd1f954af1c90eedb6e" name="gga7231ab939f4dd41f18a27ed953fda977aceb561a5b7d47bd1f954af1c90eedb6e"></a>CC_Mqtt5ReasonCode_Banned </td><td class="fielddoc"><p>value <b>Banned</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977ab733351385f69bc115d48434a65bad2f" name="gga7231ab939f4dd41f18a27ed953fda977ab733351385f69bc115d48434a65bad2f"></a>CC_Mqtt5ReasonCode_ServerShuttingDown </td><td class="fielddoc"><p>value <b>Server shutting down</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977ab9295296798cc87d65310a2d54302bee" name="gga7231ab939f4dd41f18a27ed953fda977ab9295296798cc87d65310a2d54302bee"></a>CC_Mqtt5ReasonCode_BadAuthMethod </td><td class="fielddoc"><p>value <b>Bad auth method</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a7970a93eaa2dd8e663814eb1ebb0ca9f" name="gga7231ab939f4dd41f18a27ed953fda977a7970a93eaa2dd8e663814eb1ebb0ca9f"></a>CC_Mqtt5ReasonCode_KeepAliveTimeout </td><td class="fielddoc"><p>value <b>Keep Alive timeout</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a0b82452f4e85fe0fe2fefdbfcebc7805" name="gga7231ab939f4dd41f18a27ed953fda977a0b82452f4e85fe0fe2fefdbfcebc7805"></a>CC_Mqtt5ReasonCode_SessionTakenOver </td><td class="fielddoc"><p>value <b>Session taken over</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a8c989ce5a3f1cfd1834aec410358e67f" name="gga7231ab939f4dd41f18a27ed953fda977a8c989ce5a3f1cfd1834aec410358e67f"></a>CC_Mqtt5ReasonCode_TopicFilterInvalid </td><td class="fielddoc"><p>value <b>Topic Filter invalid</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a5a294009d94b2769c99c36964d4a0572" name="gga7231ab939f4dd41f18a27ed953fda977a5a294009d94b2769c99c36964d4a0572"></a>CC_Mqtt5ReasonCode_TopicNameInvalid </td><td class="fielddoc"><p>value <b>Topic Name invalid</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a940656172e48556f035a0cabb6fc7ddc" name="gga7231ab939f4dd41f18a27ed953fda977a940656172e48556f035a0cabb6fc7ddc"></a>CC_Mqtt5ReasonCode_PacketIdInUse </td><td class="fielddoc"><p>value <b>Packet ID in use</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977ad0ba663908b1b296791b50b3d03a4f56" name="gga7231ab939f4dd41f18a27ed953fda977ad0ba663908b1b296791b50b3d03a4f56"></a>CC_Mqtt5ReasonCode_PacketIdNotFound </td><td class="fielddoc"><p>value <b>Packet ID not found</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a7ece1b58b9f13e4bfd1dcdbd2e84a9c2" name="gga7231ab939f4dd41f18a27ed953fda977a7ece1b58b9f13e4bfd1dcdbd2e84a9c2"></a>CC_Mqtt5ReasonCode_ReceiveMaxExceeded </td><td class="fielddoc"><p>value <b>Receive Max exceeded</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977aea6dddbacf8a55fb6faf6421f81ed358" name="gga7231ab939f4dd41f18a27ed953fda977aea6dddbacf8a55fb6faf6421f81ed358"></a>CC_Mqtt5ReasonCode_TopicAliasInvalid </td><td class="fielddoc"><p>value <b>Topic Alias invalid</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a8750201c93870e06e4f6a80b16a1316a" name="gga7231ab939f4dd41f18a27ed953fda977a8750201c93870e06e4f6a80b16a1316a"></a>CC_Mqtt5ReasonCode_PacketTooLarge </td><td class="fielddoc"><p>value <b>Packet too large</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977aeabe01a8f692181390143cf0414dbbcb" name="gga7231ab939f4dd41f18a27ed953fda977aeabe01a8f692181390143cf0414dbbcb"></a>CC_Mqtt5ReasonCode_MsgRateTooHigh </td><td class="fielddoc"><p>value <b>Message rate too high</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a505ed2f9313c15fbe91712ef938b772f" name="gga7231ab939f4dd41f18a27ed953fda977a505ed2f9313c15fbe91712ef938b772f"></a>CC_Mqtt5ReasonCode_QuotaExceeded </td><td class="fielddoc"><p>value <b>Quota exceeded</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977ab9240bcf5264aae6de967238cd46fe10" name="gga7231ab939f4dd41f18a27ed953fda977ab9240bcf5264aae6de967238cd46fe10"></a>CC_Mqtt5ReasonCode_AdministrativeAction </td><td class="fielddoc"><p>value <b>Administrative action</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a5af271ee0ea03034741ec2fb61fe054e" name="gga7231ab939f4dd41f18a27ed953fda977a5af271ee0ea03034741ec2fb61fe054e"></a>CC_Mqtt5ReasonCode_PayloadFormatInvalid </td><td class="fielddoc"><p>value <b>Payload format invalid</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a76b5dd23f84b2a633de8b896c9024a92" name="gga7231ab939f4dd41f18a27ed953fda977a76b5dd23f84b2a633de8b896c9024a92"></a>CC_Mqtt5ReasonCode_RetainNotSupported </td><td class="fielddoc"><p>value <b>Retain not supported</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a6905fac7da49ca63fda2c036489552c8" name="gga7231ab939f4dd41f18a27ed953fda977a6905fac7da49ca63fda2c036489552c8"></a>CC_Mqtt5ReasonCode_QosNotSupported </td><td class="fielddoc"><p>value <b>QoS not supported</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a89f2853bf29f7591d6b3c9f48a74ef9c" name="gga7231ab939f4dd41f18a27ed953fda977a89f2853bf29f7591d6b3c9f48a74ef9c"></a>CC_Mqtt5ReasonCode_UseAnotherServer </td><td class="fielddoc"><p>value <b>Use another server</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a233720c34dfe73d2e963675819c303c2" name="gga7231ab939f4dd41f18a27ed953fda977a233720c34dfe73d2e963675819c303c2"></a>CC_Mqtt5ReasonCode_ServerMoved </td><td class="fielddoc"><p>value <b>Server moved</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977ab6fd643623076c3a4acaad09c527644a" name="gga7231ab939f4dd41f18a27ed953fda977ab6fd643623076c3a4acaad09c527644a"></a>CC_Mqtt5ReasonCode_SharedSubNotSuppored </td><td class="fielddoc"><p>value <b>Shared Sub not supported</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a72fd02c98e3799a590cdc69985912374" name="gga7231ab939f4dd41f18a27ed953fda977a72fd02c98e3799a590cdc69985912374"></a>CC_Mqtt5ReasonCode_ConnectionRateExceeded </td><td class="fielddoc"><p>value <b>Connection rate exceeded</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a71cba998880657f2f083e7a8345e412d" name="gga7231ab939f4dd41f18a27ed953fda977a71cba998880657f2f083e7a8345e412d"></a>CC_Mqtt5ReasonCode_MaxConnectTime </td><td class="fielddoc"><p>value <b>Maximum connect time</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977a3bf10f878858aa4edf9e9de468fea50e" name="gga7231ab939f4dd41f18a27ed953fda977a3bf10f878858aa4edf9e9de468fea50e"></a>CC_Mqtt5ReasonCode_SubIdsNotSupported </td><td class="fielddoc"><p>value <b>Sub IDs not supported</b>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7231ab939f4dd41f18a27ed953fda977adc5c7609d381d5dd1a82963f53b8ff15" name="gga7231ab939f4dd41f18a27ed953fda977adc5c7609d381d5dd1a82963f53b8ff15"></a>CC_Mqtt5ReasonCode_WildcardSubsNotSupported </td><td class="fielddoc"><p>value <b>Wildcard Subs not supported</b>. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga17b1578d844c75274357e5b9f23f3ace" name="ga17b1578d844c75274357e5b9f23f3ace"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga17b1578d844c75274357e5b9f23f3ace">◆ </a></span>cc_mqtt5_client_init_user_prop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cc_mqtt5_client_init_user_prop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structCC__Mqtt5UserProp.html">CC_Mqtt5UserProp</a> * </td>
<td class="paramname"><em>prop</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Intialize the <a class="el" href="structCC__Mqtt5UserProp.html">CC_Mqtt5UserProp</a> structure. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">prop</td><td>User property info. Must not be NULL. </td></tr>
</table>
</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>