-
Notifications
You must be signed in to change notification settings - Fork 0
/
common_8h.html
427 lines (421 loc) · 55.8 KB
/
common_8h.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
<!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: common.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">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>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle"><div class="title">common.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Common definition for MQTT v5 clients.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <stdbool.h></code><br />
</div>
<p><a href="common_8h_source.html">Go to the source code of this file.</a></p>
<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__Mqtt5ConnectBasicConfig.html">CC_Mqtt5ConnectBasicConfig</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Configuration structure to be passed to the <b><a class="el" href="group__connect.html#gaf2a947ad8801a6d2cc3b0d68981b5308" title="Perform basic configuration of the "connect" operation.">cc_mqtt5_client_connect_config_basic()</a></b>. <a href="structCC__Mqtt5ConnectBasicConfig.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__Mqtt5ConnectExtraConfig.html">CC_Mqtt5ConnectExtraConfig</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Extra properties configuration of the "connect" operation. <a href="structCC__Mqtt5ConnectExtraConfig.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__Mqtt5ConnectResponse.html">CC_Mqtt5ConnectResponse</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Response information from broker to "connect" request. <a href="structCC__Mqtt5ConnectResponse.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__Mqtt5ConnectWillConfig.html">CC_Mqtt5ConnectWillConfig</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Configuration structure to be passed to the <b><a class="el" href="group__connect.html#ga958c2fbc2dd9d159fe8786a3053e3706" title="Perform will configuration of the "connect" operation.">cc_mqtt5_client_connect_config_will()</a></b>. <a href="structCC__Mqtt5ConnectWillConfig.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__Mqtt5DisconnectConfig.html">CC_Mqtt5DisconnectConfig</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Configuration structure of the "disconnect" operation. <a href="structCC__Mqtt5DisconnectConfig.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__Mqtt5PublishBasicConfig.html">CC_Mqtt5PublishBasicConfig</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Configuration structure to be passed to the <b><a class="el" href="group__publish.html#ga26d76d06ea71b80772de903d0418ec15" title="Perform basic configuration of the "publish" operation.">cc_mqtt5_client_publish_config_basic()</a></b>. <a href="structCC__Mqtt5PublishBasicConfig.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__Mqtt5PublishExtraConfig.html">CC_Mqtt5PublishExtraConfig</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Configuration structure to be passed to the <b><a class="el" href="group__publish.html#gaae32b8550c3448c54d7fb373ba2214ac" title="Perform extra properties configuration of the "publish" operation.">cc_mqtt5_client_publish_config_extra()</a></b>. <a href="structCC__Mqtt5PublishExtraConfig.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__Mqtt5PublishResponse.html">CC_Mqtt5PublishResponse</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Response information from broker to "publish" request. <a href="structCC__Mqtt5PublishResponse.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__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>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structCC__Mqtt5UnsubscribeResponse.html">CC_Mqtt5UnsubscribeResponse</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Response information from broker to "unsubscribe" request. <a href="structCC__Mqtt5UnsubscribeResponse.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__Mqtt5UnsubscribeTopicConfig.html">CC_Mqtt5UnsubscribeTopicConfig</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Topic filter configuration structure of the "unsubscribe" operation. <a href="structCC__Mqtt5UnsubscribeTopicConfig.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">
#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">
#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">
#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">
#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">
#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="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a4763183da0cfbc4c0ec588d2ebf71430" id="r_a4763183da0cfbc4c0ec588d2ebf71430"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__global.html#gaa2b0e4ecc24bfd83703e722793a0bca1">CC_Mqtt5AuthErrorCode</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="common_8h.html#a4763183da0cfbc4c0ec588d2ebf71430">CC_Mqtt5AuthCb</a>) (void *data, const <a class="el" href="structCC__Mqtt5AuthInfo.html">CC_Mqtt5AuthInfo</a> *authInfoIn, <a class="el" href="structCC__Mqtt5AuthInfo.html">CC_Mqtt5AuthInfo</a> *authInfoOut)</td></tr>
<tr class="memdesc:a4763183da0cfbc4c0ec588d2ebf71430"><td class="mdescLeft"> </td><td class="mdescRight">Callback used to report incoming authentication data. <br /></td></tr>
<tr class="separator:a4763183da0cfbc4c0ec588d2ebf71430"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabb7c8c7342ebbc6883579d885f4dedb7" id="r_gabb7c8c7342ebbc6883579d885f4dedb7"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__client.html#gabb7c8c7342ebbc6883579d885f4dedb7">CC_Mqtt5BrokerDisconnectReportCb</a>) (void *data, <a class="el" href="group__global.html#gade2ba1fc06381168fc1c7c510a18bf41">CC_Mqtt5BrokerDisconnectReason</a> reason, const <a class="el" href="structCC__Mqtt5DisconnectInfo.html">CC_Mqtt5DisconnectInfo</a> *info)</td></tr>
<tr class="memdesc:gabb7c8c7342ebbc6883579d885f4dedb7"><td class="mdescLeft"> </td><td class="mdescRight">Callback used to report unsolicited disconnection of the broker. <br /></td></tr>
<tr class="separator:gabb7c8c7342ebbc6883579d885f4dedb7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gada43a479edab17c2994410985a80678c" id="r_gada43a479edab17c2994410985a80678c"><td class="memItemLeft" align="right" valign="top">typedef unsigned(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__client.html#gada43a479edab17c2994410985a80678c">CC_Mqtt5CancelNextTickWaitCb</a>) (void *data)</td></tr>
<tr class="memdesc:gada43a479edab17c2994410985a80678c"><td class="mdescLeft"> </td><td class="mdescRight">Callback used to request termination of existing time measurement. <br /></td></tr>
<tr class="separator:gada43a479edab17c2994410985a80678c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6c225736aebda7ec79fca5701036ed15" id="r_ga6c225736aebda7ec79fca5701036ed15"><td class="memItemLeft" align="right" valign="top">typedef struct CC_Mqtt5Client * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__client.html#ga6c225736aebda7ec79fca5701036ed15">CC_Mqtt5ClientHandle</a></td></tr>
<tr class="memdesc:ga6c225736aebda7ec79fca5701036ed15"><td class="mdescLeft"> </td><td class="mdescRight">Handle used to access client specific data structures. <br /></td></tr>
<tr class="separator:ga6c225736aebda7ec79fca5701036ed15"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga487f738d4045ede25cbca63ee567780d" id="r_ga487f738d4045ede25cbca63ee567780d"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connect.html#ga487f738d4045ede25cbca63ee567780d">CC_Mqtt5ConnectCompleteCb</a>) (void *data, <a class="el" href="group__global.html#gabd56266bda747f19e4c6669fa0da021d">CC_Mqtt5AsyncOpStatus</a> status, const <a class="el" href="structCC__Mqtt5ConnectResponse.html">CC_Mqtt5ConnectResponse</a> *response)</td></tr>
<tr class="memdesc:ga487f738d4045ede25cbca63ee567780d"><td class="mdescLeft"> </td><td class="mdescRight">Callback used to report completion of the "connect" operation. <br /></td></tr>
<tr class="separator:ga487f738d4045ede25cbca63ee567780d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4517ec98d82cfe4df98f217d9a8f8d04" id="r_ga4517ec98d82cfe4df98f217d9a8f8d04"><td class="memItemLeft" align="right" valign="top">typedef struct CC_Mqtt5Connect * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__connect.html#ga4517ec98d82cfe4df98f217d9a8f8d04">CC_Mqtt5ConnectHandle</a></td></tr>
<tr class="memdesc:ga4517ec98d82cfe4df98f217d9a8f8d04"><td class="mdescLeft"> </td><td class="mdescRight">Handle for "connect" operation. <br /></td></tr>
<tr class="separator:ga4517ec98d82cfe4df98f217d9a8f8d04"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8ebdee9f35dcbac7ab3e52315ca09c77" id="r_ga8ebdee9f35dcbac7ab3e52315ca09c77"><td class="memItemLeft" align="right" valign="top">typedef struct CC_Mqtt5Disconnect * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__disconnect.html#ga8ebdee9f35dcbac7ab3e52315ca09c77">CC_Mqtt5DisconnectHandle</a></td></tr>
<tr class="memdesc:ga8ebdee9f35dcbac7ab3e52315ca09c77"><td class="mdescLeft"> </td><td class="mdescRight">Handle for "disconnect" operation. <br /></td></tr>
<tr class="separator:ga8ebdee9f35dcbac7ab3e52315ca09c77"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae7fbcff469df2e638429d3d2cbc9c17e" id="r_gae7fbcff469df2e638429d3d2cbc9c17e"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__client.html#gae7fbcff469df2e638429d3d2cbc9c17e">CC_Mqtt5ErrorLogCb</a>) (void *data, const char *msg)</td></tr>
<tr class="memdesc:gae7fbcff469df2e638429d3d2cbc9c17e"><td class="mdescLeft"> </td><td class="mdescRight">Callback used to report discovered errors. <br /></td></tr>
<tr class="separator:gae7fbcff469df2e638429d3d2cbc9c17e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4ce5ee72b2dda212cea9a448df397513" id="r_ga4ce5ee72b2dda212cea9a448df397513"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__client.html#ga4ce5ee72b2dda212cea9a448df397513">CC_Mqtt5MessageReceivedReportCb</a>) (void *data, const <a class="el" href="structCC__Mqtt5MessageInfo.html">CC_Mqtt5MessageInfo</a> *info)</td></tr>
<tr class="memdesc:ga4ce5ee72b2dda212cea9a448df397513"><td class="mdescLeft"> </td><td class="mdescRight">Callback used to report new message received of the broker. <br /></td></tr>
<tr class="separator:ga4ce5ee72b2dda212cea9a448df397513"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5366e3a41330389dfa5befed0eb2a59a" id="r_ga5366e3a41330389dfa5befed0eb2a59a"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__client.html#ga5366e3a41330389dfa5befed0eb2a59a">CC_Mqtt5NextTickProgramCb</a>) (void *data, unsigned duration)</td></tr>
<tr class="memdesc:ga5366e3a41330389dfa5befed0eb2a59a"><td class="mdescLeft"> </td><td class="mdescRight">Callback used to request time measurement. <br /></td></tr>
<tr class="separator:ga5366e3a41330389dfa5befed0eb2a59a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7911ab79b27c77d887fb2fd491ab5c42" id="r_ga7911ab79b27c77d887fb2fd491ab5c42"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__publish.html#ga7911ab79b27c77d887fb2fd491ab5c42">CC_Mqtt5PublishCompleteCb</a>) (void *data, <a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a> handle, <a class="el" href="group__global.html#gabd56266bda747f19e4c6669fa0da021d">CC_Mqtt5AsyncOpStatus</a> status, const <a class="el" href="structCC__Mqtt5PublishResponse.html">CC_Mqtt5PublishResponse</a> *response)</td></tr>
<tr class="memdesc:ga7911ab79b27c77d887fb2fd491ab5c42"><td class="mdescLeft"> </td><td class="mdescRight">Callback used to report completion of the "publish" operation. <br /></td></tr>
<tr class="separator:ga7911ab79b27c77d887fb2fd491ab5c42"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabb1e556a5d03323a84209dcdc57a63f8" id="r_gabb1e556a5d03323a84209dcdc57a63f8"><td class="memItemLeft" align="right" valign="top">typedef struct CC_Mqtt5Publish * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a></td></tr>
<tr class="memdesc:gabb1e556a5d03323a84209dcdc57a63f8"><td class="mdescLeft"> </td><td class="mdescRight">Handle for "publish" operation. <br /></td></tr>
<tr class="separator:gabb1e556a5d03323a84209dcdc57a63f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4b0e66010307e1cb3e0c7ddfe0cba84c" id="r_ga4b0e66010307e1cb3e0c7ddfe0cba84c"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__reauth.html#ga4b0e66010307e1cb3e0c7ddfe0cba84c">CC_Mqtt5ReauthCompleteCb</a>) (void *data, <a class="el" href="group__global.html#gabd56266bda747f19e4c6669fa0da021d">CC_Mqtt5AsyncOpStatus</a> status, const <a class="el" href="structCC__Mqtt5AuthInfo.html">CC_Mqtt5AuthInfo</a> *response)</td></tr>
<tr class="memdesc:ga4b0e66010307e1cb3e0c7ddfe0cba84c"><td class="mdescLeft"> </td><td class="mdescRight">Callback used to report completion of the "reauth" operation. <br /></td></tr>
<tr class="separator:ga4b0e66010307e1cb3e0c7ddfe0cba84c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5ecb0c9d4cec28d43dbfa1fc6ce74627" id="r_ga5ecb0c9d4cec28d43dbfa1fc6ce74627"><td class="memItemLeft" align="right" valign="top">typedef struct CC_Mqtt5Reauth * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__reauth.html#ga5ecb0c9d4cec28d43dbfa1fc6ce74627">CC_Mqtt5ReauthHandle</a></td></tr>
<tr class="memdesc:ga5ecb0c9d4cec28d43dbfa1fc6ce74627"><td class="mdescLeft"> </td><td class="mdescRight">Handle for "reauth" operation. <br /></td></tr>
<tr class="separator:ga5ecb0c9d4cec28d43dbfa1fc6ce74627"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac26155abcf6af88f3e7f3f858ce1eda2" id="r_gac26155abcf6af88f3e7f3f858ce1eda2"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__client.html#gac26155abcf6af88f3e7f3f858ce1eda2">CC_Mqtt5SendOutputDataCb</a>) (void *data, const unsigned char *buf, unsigned bufLen)</td></tr>
<tr class="memdesc:gac26155abcf6af88f3e7f3f858ce1eda2"><td class="mdescLeft"> </td><td class="mdescRight">Callback used to request to send data to the broker. <br /></td></tr>
<tr class="separator:gac26155abcf6af88f3e7f3f858ce1eda2"><td class="memSeparator" colspan="2"> </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>
<tr class="memitem:ga0215df458f9235b3e2371667755e989d" id="r_ga0215df458f9235b3e2371667755e989d"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__unsubscribe.html#ga0215df458f9235b3e2371667755e989d">CC_Mqtt5UnsubscribeCompleteCb</a>) (void *data, <a class="el" href="group__unsubscribe.html#gad9a2a7fd15bd160cdd99796b1a65c7c7">CC_Mqtt5UnsubscribeHandle</a> handle, <a class="el" href="group__global.html#gabd56266bda747f19e4c6669fa0da021d">CC_Mqtt5AsyncOpStatus</a> status, const <a class="el" href="structCC__Mqtt5UnsubscribeResponse.html">CC_Mqtt5UnsubscribeResponse</a> *response)</td></tr>
<tr class="memdesc:ga0215df458f9235b3e2371667755e989d"><td class="mdescLeft"> </td><td class="mdescRight">Callback used to report completion of the "unsubscribe" operation. <br /></td></tr>
<tr class="separator:ga0215df458f9235b3e2371667755e989d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad9a2a7fd15bd160cdd99796b1a65c7c7" id="r_gad9a2a7fd15bd160cdd99796b1a65c7c7"><td class="memItemLeft" align="right" valign="top">typedef struct CC_Mqtt5Unsubscribe * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__unsubscribe.html#gad9a2a7fd15bd160cdd99796b1a65c7c7">CC_Mqtt5UnsubscribeHandle</a></td></tr>
<tr class="memdesc:gad9a2a7fd15bd160cdd99796b1a65c7c7"><td class="mdescLeft"> </td><td class="mdescRight">Handle for "unsubscribe" operation. <br /></td></tr>
<tr class="separator:gad9a2a7fd15bd160cdd99796b1a65c7c7"><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:gac670d5217c079165d7c438648e28215f" id="r_gac670d5217c079165d7c438648e28215f"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__publish.html#gac670d5217c079165d7c438648e28215f">CC_Mqtt5PublishOrdering</a> { <a class="el" href="group__publish.html#ggac670d5217c079165d7c438648e28215fa7f2c1494e952d42f09b434e09fc715bd">CC_Mqtt5PublishOrdering_SameQos</a>
, <a class="el" href="group__publish.html#ggac670d5217c079165d7c438648e28215fa675765052d939c28676fb6b06bfa48a7">CC_Mqtt5PublishOrdering_Full</a>
, <a class="el" href="group__publish.html#ggac670d5217c079165d7c438648e28215facd684a669069eb6a090911cea2a1dc2e">CC_Mqtt5PublishOrdering_ValuesLimit</a>
}</td></tr>
<tr class="memdesc:gac670d5217c079165d7c438648e28215f"><td class="mdescLeft"> </td><td class="mdescRight">Publish ordering configuration. <a href="group__publish.html#gac670d5217c079165d7c438648e28215f">More...</a><br /></td></tr>
<tr class="separator:gac670d5217c079165d7c438648e28215f"><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>
<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>
<tr class="memitem:ga3f6ff6abe155494dc72eff08c90af002" id="r_ga3f6ff6abe155494dc72eff08c90af002"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__publish.html#ga3f6ff6abe155494dc72eff08c90af002">CC_Mqtt5TopicAliasPreference</a> { <br />
  <a class="el" href="group__publish.html#gga3f6ff6abe155494dc72eff08c90af002a1c9ece499481ece8d7a46c54e4f1e9ba">CC_Mqtt5TopicAliasPreference_UseAliasIfAvailable</a> = 0
, <a class="el" href="group__publish.html#gga3f6ff6abe155494dc72eff08c90af002a239d318694194603c075a8f722ebd0b7">CC_Mqtt5TopicAliasPreference_ForceAliasOnly</a> = 1
, <a class="el" href="group__publish.html#gga3f6ff6abe155494dc72eff08c90af002a7d36e469ab78e6c09e769df53d5ccbb5">CC_Mqtt5TopicAliasPreference_ForceTopicOnly</a> = 2
, <a class="el" href="group__publish.html#gga3f6ff6abe155494dc72eff08c90af002a583df4fa8625cec3124151454becf63f">CC_Mqtt5TopicAliasPreference_ForceTopicWithAlias</a> = 3
, <br />
  <a class="el" href="group__publish.html#gga3f6ff6abe155494dc72eff08c90af002aead576e251681dea5dc38ae2285a0adc">CC_Mqtt5TopicAliasPreference_ValuesLimit</a>
<br />
}</td></tr>
<tr class="memdesc:ga3f6ff6abe155494dc72eff08c90af002"><td class="mdescLeft"> </td><td class="mdescRight">Preference of whether to use numeric "Topic Alias" instead of string topic during publish operation. <a href="group__publish.html#ga3f6ff6abe155494dc72eff08c90af002">More...</a><br /></td></tr>
<tr class="separator:ga3f6ff6abe155494dc72eff08c90af002"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Common definition for MQTT v5 clients. </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a4763183da0cfbc4c0ec588d2ebf71430" name="a4763183da0cfbc4c0ec588d2ebf71430"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4763183da0cfbc4c0ec588d2ebf71430">◆ </a></span>CC_Mqtt5AuthCb</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="group__global.html#gaa2b0e4ecc24bfd83703e722793a0bca1">CC_Mqtt5AuthErrorCode</a>(* CC_Mqtt5AuthCb) (void *data, const <a class="el" href="structCC__Mqtt5AuthInfo.html">CC_Mqtt5AuthInfo</a> *authInfoIn, <a class="el" href="structCC__Mqtt5AuthInfo.html">CC_Mqtt5AuthInfo</a> *authInfoOut)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback used to report incoming authentication data. </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 during callback registration. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">authInfoIn</td><td>Pointer to authentication data received from broker. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">authInfoOut</td><td>Pointer to authentication data to be sent to the broker. Expected to be filled by the callback. </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>