-
Notifications
You must be signed in to change notification settings - Fork 0
/
group__publish.html
941 lines (873 loc) · 65.6 KB
/
group__publish.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
<!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: "Publish Operation Data Type and Functions"</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">CommsChampion Ecosystem MQTT v5 Client
</div>
<div id="projectbrief">MQTT v5 Client Library.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">"Publish Operation Data Type and Functions"</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structCC__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>
</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: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>
</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: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: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><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:ga9fe48afc42867e3eb9cbfcf26d0e71da" id="r_ga9fe48afc42867e3eb9cbfcf26d0e71da"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__publish.html#ga9fe48afc42867e3eb9cbfcf26d0e71da">cc_mqtt5_client_publish_add_user_prop</a> (<a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a> handle, const <a class="el" href="structCC__Mqtt5UserProp.html">CC_Mqtt5UserProp</a> *prop)</td></tr>
<tr class="memdesc:ga9fe48afc42867e3eb9cbfcf26d0e71da"><td class="mdescLeft"> </td><td class="mdescRight">Add user property to the configuration of the "publish" operation. <br /></td></tr>
<tr class="separator:ga9fe48afc42867e3eb9cbfcf26d0e71da"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad3e4a970267a4634242cda4655b86ddc" id="r_gad3e4a970267a4634242cda4655b86ddc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__publish.html#gad3e4a970267a4634242cda4655b86ddc">cc_mqtt5_client_publish_cancel</a> (<a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a> handle)</td></tr>
<tr class="memdesc:gad3e4a970267a4634242cda4655b86ddc"><td class="mdescLeft"> </td><td class="mdescRight">Cancel the allocated "publish" operation. <br /></td></tr>
<tr class="separator:gad3e4a970267a4634242cda4655b86ddc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga26d76d06ea71b80772de903d0418ec15" id="r_ga26d76d06ea71b80772de903d0418ec15"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__publish.html#ga26d76d06ea71b80772de903d0418ec15">cc_mqtt5_client_publish_config_basic</a> (<a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a> handle, const <a class="el" href="structCC__Mqtt5PublishBasicConfig.html">CC_Mqtt5PublishBasicConfig</a> *config)</td></tr>
<tr class="memdesc:ga26d76d06ea71b80772de903d0418ec15"><td class="mdescLeft"> </td><td class="mdescRight">Perform basic configuration of the "publish" operation. <br /></td></tr>
<tr class="separator:ga26d76d06ea71b80772de903d0418ec15"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaae32b8550c3448c54d7fb373ba2214ac" id="r_gaae32b8550c3448c54d7fb373ba2214ac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__publish.html#gaae32b8550c3448c54d7fb373ba2214ac">cc_mqtt5_client_publish_config_extra</a> (<a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a> handle, const <a class="el" href="structCC__Mqtt5PublishExtraConfig.html">CC_Mqtt5PublishExtraConfig</a> *config)</td></tr>
<tr class="memdesc:gaae32b8550c3448c54d7fb373ba2214ac"><td class="mdescLeft"> </td><td class="mdescRight">Perform extra properties configuration of the "publish" operation. <br /></td></tr>
<tr class="separator:gaae32b8550c3448c54d7fb373ba2214ac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8db7a1a3d48471f8af354ca64dd5d6e9" id="r_ga8db7a1a3d48471f8af354ca64dd5d6e9"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="group__publish.html#ga8db7a1a3d48471f8af354ca64dd5d6e9">cc_mqtt5_client_publish_count</a> (<a class="el" href="group__client.html#ga6c225736aebda7ec79fca5701036ed15">CC_Mqtt5ClientHandle</a> handle)</td></tr>
<tr class="memdesc:ga8db7a1a3d48471f8af354ca64dd5d6e9"><td class="mdescLeft"> </td><td class="mdescRight">Get amount incomplete "publish" operations. <br /></td></tr>
<tr class="separator:ga8db7a1a3d48471f8af354ca64dd5d6e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3f05f5d3b412ce6bd4fa724afecbee4e" id="r_ga3f05f5d3b412ce6bd4fa724afecbee4e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__publish.html#ga3f05f5d3b412ce6bd4fa724afecbee4e">cc_mqtt5_client_publish_full</a> (<a class="el" href="group__client.html#ga6c225736aebda7ec79fca5701036ed15">CC_Mqtt5ClientHandle</a> handle, const <a class="el" href="structCC__Mqtt5PublishBasicConfig.html">CC_Mqtt5PublishBasicConfig</a> *basicConfig, const <a class="el" href="structCC__Mqtt5PublishExtraConfig.html">CC_Mqtt5PublishExtraConfig</a> *extraConfig, <a class="el" href="group__publish.html#ga7911ab79b27c77d887fb2fd491ab5c42">CC_Mqtt5PublishCompleteCb</a> cb, void *cbData)</td></tr>
<tr class="memdesc:ga3f05f5d3b412ce6bd4fa724afecbee4e"><td class="mdescLeft"> </td><td class="mdescRight">Prepare, configure, and send "publish" request in one go (full version) <br /></td></tr>
<tr class="separator:ga3f05f5d3b412ce6bd4fa724afecbee4e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5389ff87af1e2982b0fd9122489b4ffd" id="r_ga5389ff87af1e2982b0fd9122489b4ffd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__publish.html#gac670d5217c079165d7c438648e28215f">CC_Mqtt5PublishOrdering</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__publish.html#ga5389ff87af1e2982b0fd9122489b4ffd">cc_mqtt5_client_publish_get_ordering</a> (<a class="el" href="group__client.html#ga6c225736aebda7ec79fca5701036ed15">CC_Mqtt5ClientHandle</a> handle)</td></tr>
<tr class="memdesc:ga5389ff87af1e2982b0fd9122489b4ffd"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the configured the publish operations ordering. <br /></td></tr>
<tr class="separator:ga5389ff87af1e2982b0fd9122489b4ffd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac4cd4b0346ab8c622bc962b1a2f6386e" id="r_gac4cd4b0346ab8c622bc962b1a2f6386e"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="group__publish.html#gac4cd4b0346ab8c622bc962b1a2f6386e">cc_mqtt5_client_publish_get_resend_attempts</a> (<a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a> handle)</td></tr>
<tr class="memdesc:gac4cd4b0346ab8c622bc962b1a2f6386e"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the configured the amount of resend attempts for the "publish" operation. <br /></td></tr>
<tr class="separator:gac4cd4b0346ab8c622bc962b1a2f6386e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga27189d64a90fa6c190848467a5237023" id="r_ga27189d64a90fa6c190848467a5237023"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="group__publish.html#ga27189d64a90fa6c190848467a5237023">cc_mqtt5_client_publish_get_response_timeout</a> (<a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a> handle)</td></tr>
<tr class="memdesc:ga27189d64a90fa6c190848467a5237023"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the configured the broker response timeout for the "publish" operation. <br /></td></tr>
<tr class="separator:ga27189d64a90fa6c190848467a5237023"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa2dd7ba8568d1cc308c366923f15c06c" id="r_gaa2dd7ba8568d1cc308c366923f15c06c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__publish.html#gaa2dd7ba8568d1cc308c366923f15c06c">cc_mqtt5_client_publish_init_config_basic</a> (<a class="el" href="structCC__Mqtt5PublishBasicConfig.html">CC_Mqtt5PublishBasicConfig</a> *config)</td></tr>
<tr class="memdesc:gaa2dd7ba8568d1cc308c366923f15c06c"><td class="mdescLeft"> </td><td class="mdescRight">Intialize the <a class="el" href="structCC__Mqtt5PublishBasicConfig.html">CC_Mqtt5PublishBasicConfig</a> configuration structure. <br /></td></tr>
<tr class="separator:gaa2dd7ba8568d1cc308c366923f15c06c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3364b7d98f39c4c17a88e9f74d76326d" id="r_ga3364b7d98f39c4c17a88e9f74d76326d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__publish.html#ga3364b7d98f39c4c17a88e9f74d76326d">cc_mqtt5_client_publish_init_config_extra</a> (<a class="el" href="structCC__Mqtt5PublishExtraConfig.html">CC_Mqtt5PublishExtraConfig</a> *config)</td></tr>
<tr class="memdesc:ga3364b7d98f39c4c17a88e9f74d76326d"><td class="mdescLeft"> </td><td class="mdescRight">Intialize the <a class="el" href="structCC__Mqtt5PublishExtraConfig.html">CC_Mqtt5PublishExtraConfig</a> configuration structure. <br /></td></tr>
<tr class="separator:ga3364b7d98f39c4c17a88e9f74d76326d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8ba52035a9ea815cbc65592d93bfc1cf" id="r_ga8ba52035a9ea815cbc65592d93bfc1cf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__publish.html#ga8ba52035a9ea815cbc65592d93bfc1cf">cc_mqtt5_client_publish_prepare</a> (<a class="el" href="group__client.html#ga6c225736aebda7ec79fca5701036ed15">CC_Mqtt5ClientHandle</a> handle, <a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> *ec)</td></tr>
<tr class="memdesc:ga8ba52035a9ea815cbc65592d93bfc1cf"><td class="mdescLeft"> </td><td class="mdescRight">Prepare "publish" operation. <br /></td></tr>
<tr class="separator:ga8ba52035a9ea815cbc65592d93bfc1cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf19c2d2953ee67a413877681fcf8fcc9" id="r_gaf19c2d2953ee67a413877681fcf8fcc9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__publish.html#gaf19c2d2953ee67a413877681fcf8fcc9">cc_mqtt5_client_publish_send</a> (<a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a> handle, <a class="el" href="group__publish.html#ga7911ab79b27c77d887fb2fd491ab5c42">CC_Mqtt5PublishCompleteCb</a> cb, void *cbData)</td></tr>
<tr class="memdesc:gaf19c2d2953ee67a413877681fcf8fcc9"><td class="mdescLeft"> </td><td class="mdescRight">Send the configured "publish" operation to broker. <br /></td></tr>
<tr class="separator:gaf19c2d2953ee67a413877681fcf8fcc9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4f2facec3ef1b1150ad33f6241b9c7b4" id="r_ga4f2facec3ef1b1150ad33f6241b9c7b4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__publish.html#ga4f2facec3ef1b1150ad33f6241b9c7b4">cc_mqtt5_client_publish_set_ordering</a> (<a class="el" href="group__client.html#ga6c225736aebda7ec79fca5701036ed15">CC_Mqtt5ClientHandle</a> handle, <a class="el" href="group__publish.html#gac670d5217c079165d7c438648e28215f">CC_Mqtt5PublishOrdering</a> ordering)</td></tr>
<tr class="memdesc:ga4f2facec3ef1b1150ad33f6241b9c7b4"><td class="mdescLeft"> </td><td class="mdescRight">Configure the ordering of the published messages. <br /></td></tr>
<tr class="separator:ga4f2facec3ef1b1150ad33f6241b9c7b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae8e04a144f923f3e5829c3522b1f22ba" id="r_gae8e04a144f923f3e5829c3522b1f22ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__publish.html#gae8e04a144f923f3e5829c3522b1f22ba">cc_mqtt5_client_publish_set_resend_attempts</a> (<a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a> handle, unsigned attempts)</td></tr>
<tr class="memdesc:gae8e04a144f923f3e5829c3522b1f22ba"><td class="mdescLeft"> </td><td class="mdescRight">Configure the amount of attempts to resend "publish" operation until the acknowledgement is received. <br /></td></tr>
<tr class="separator:gae8e04a144f923f3e5829c3522b1f22ba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8d1bfed81a79f8460f6cc679bdd157cd" id="r_ga8d1bfed81a79f8460f6cc679bdd157cd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__publish.html#ga8d1bfed81a79f8460f6cc679bdd157cd">cc_mqtt5_client_publish_set_response_timeout</a> (<a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a> handle, unsigned ms)</td></tr>
<tr class="memdesc:ga8d1bfed81a79f8460f6cc679bdd157cd"><td class="mdescLeft"> </td><td class="mdescRight">Configure the broker response timeout for the "publish" operation. <br /></td></tr>
<tr class="separator:ga8d1bfed81a79f8460f6cc679bdd157cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4dec892b420aa6bc0a036986c81e9d4c" id="r_ga4dec892b420aa6bc0a036986c81e9d4c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__publish.html#ga4dec892b420aa6bc0a036986c81e9d4c">cc_mqtt5_client_publish_simple</a> (<a class="el" href="group__client.html#ga6c225736aebda7ec79fca5701036ed15">CC_Mqtt5ClientHandle</a> handle, const <a class="el" href="structCC__Mqtt5PublishBasicConfig.html">CC_Mqtt5PublishBasicConfig</a> *basicConfig, <a class="el" href="group__publish.html#ga7911ab79b27c77d887fb2fd491ab5c42">CC_Mqtt5PublishCompleteCb</a> cb, void *cbData)</td></tr>
<tr class="memdesc:ga4dec892b420aa6bc0a036986c81e9d4c"><td class="mdescLeft"> </td><td class="mdescRight">Prepare, configure, and send "publish" request in one go (simple version) <br /></td></tr>
<tr class="separator:ga4dec892b420aa6bc0a036986c81e9d4c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaeec796c480e4d7b8384aca93cf0396cb" id="r_gaeec796c480e4d7b8384aca93cf0396cb"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__publish.html#gaeec796c480e4d7b8384aca93cf0396cb">cc_mqtt5_client_publish_was_initiated</a> (<a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a> handle)</td></tr>
<tr class="memdesc:gaeec796c480e4d7b8384aca93cf0396cb"><td class="mdescLeft"> </td><td class="mdescRight">Check whether the "publish" operation was actually initiated (PUBLISH was sent) <br /></td></tr>
<tr class="separator:gaeec796c480e4d7b8384aca93cf0396cb"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga7911ab79b27c77d887fb2fd491ab5c42" name="ga7911ab79b27c77d887fb2fd491ab5c42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7911ab79b27c77d887fb2fd491ab5c42">◆ </a></span>CC_Mqtt5PublishCompleteCb</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* CC_Mqtt5PublishCompleteCb) (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>
</table>
</div><div class="memdoc">
<p>Callback used to report completion of the "publish" operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Pointer to user data object passed as last parameter to the <b><a class="el" href="group__publish.html#gaf19c2d2953ee67a413877681fcf8fcc9" title="Send the configured "publish" operation to broker.">cc_mqtt5_client_publish_send()</a></b>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <b><a class="el" href="group__publish.html#ga8ba52035a9ea815cbc65592d93bfc1cf" title="Prepare "publish" operation.">cc_mqtt5_client_publish_prepare()</a></b> function. When the callback is invoked the handle is already invalid and cannot be used in any relevant function invocation, but it allows end application to identify the original "publish" operation and use the same callback function in parallel requests. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">status</td><td>Status of the "publish" operation. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">response</td><td>Response information from the broker. Not-NULL is reported <b>if and onfly if</b> the "status" is equal to <a class="el" href="group__global.html#ggabd56266bda747f19e4c6669fa0da021da1612bd223303ddf181264c196d24855d">CC_Mqtt5AsyncOpStatus_Complete</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section post"><dt>Postcondition</dt><dd>The data members of the reported response can NOT be accessed after the function returns. </dd></dl>
</div>
</div>
<a id="gabb1e556a5d03323a84209dcdc57a63f8" name="gabb1e556a5d03323a84209dcdc57a63f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabb1e556a5d03323a84209dcdc57a63f8">◆ </a></span>CC_Mqtt5PublishHandle</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct CC_Mqtt5Publish* <a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Handle for "publish" operation. </p>
<p>Returned by <a class="el" href="group__publish.html#ga8ba52035a9ea815cbc65592d93bfc1cf" title="Prepare "publish" operation.">cc_mqtt5_client_publish_prepare()</a> function. </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="gac670d5217c079165d7c438648e28215f" name="gac670d5217c079165d7c438648e28215f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac670d5217c079165d7c438648e28215f">◆ </a></span>CC_Mqtt5PublishOrdering</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__publish.html#gac670d5217c079165d7c438648e28215f">CC_Mqtt5PublishOrdering</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Publish ordering configuration. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggac670d5217c079165d7c438648e28215fa7f2c1494e952d42f09b434e09fc715bd" name="ggac670d5217c079165d7c438648e28215fa7f2c1494e952d42f09b434e09fc715bd"></a>CC_Mqtt5PublishOrdering_SameQos </td><td class="fielddoc"><p>Preserve strict order only between same QoS messages. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac670d5217c079165d7c438648e28215fa675765052d939c28676fb6b06bfa48a7" name="ggac670d5217c079165d7c438648e28215fa675765052d939c28676fb6b06bfa48a7"></a>CC_Mqtt5PublishOrdering_Full </td><td class="fielddoc"><p>Preserve strict order between <b>all</b> messages. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac670d5217c079165d7c438648e28215facd684a669069eb6a090911cea2a1dc2e" name="ggac670d5217c079165d7c438648e28215facd684a669069eb6a090911cea2a1dc2e"></a>CC_Mqtt5PublishOrdering_ValuesLimit </td><td class="fielddoc"><p>Limit for the values. </p>
</td></tr>
</table>
</div>
</div>
<a id="ga3f6ff6abe155494dc72eff08c90af002" name="ga3f6ff6abe155494dc72eff08c90af002"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3f6ff6abe155494dc72eff08c90af002">◆ </a></span>CC_Mqtt5TopicAliasPreference</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__publish.html#ga3f6ff6abe155494dc72eff08c90af002">CC_Mqtt5TopicAliasPreference</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Preference of whether to use numeric "Topic Alias" instead of string topic during publish operation. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga3f6ff6abe155494dc72eff08c90af002a1c9ece499481ece8d7a46c54e4f1e9ba" name="gga3f6ff6abe155494dc72eff08c90af002a1c9ece499481ece8d7a46c54e4f1e9ba"></a>CC_Mqtt5TopicAliasPreference_UseAliasIfAvailable </td><td class="fielddoc"><p>Use topic alias if such is available. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3f6ff6abe155494dc72eff08c90af002a239d318694194603c075a8f722ebd0b7" name="gga3f6ff6abe155494dc72eff08c90af002a239d318694194603c075a8f722ebd0b7"></a>CC_Mqtt5TopicAliasPreference_ForceAliasOnly </td><td class="fielddoc"><p>Force sending topic alias, requires topic alias to be allocated. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3f6ff6abe155494dc72eff08c90af002a7d36e469ab78e6c09e769df53d5ccbb5" name="gga3f6ff6abe155494dc72eff08c90af002a7d36e469ab78e6c09e769df53d5ccbb5"></a>CC_Mqtt5TopicAliasPreference_ForceTopicOnly </td><td class="fielddoc"><p>Force sending topic string even if topic alias is available. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3f6ff6abe155494dc72eff08c90af002a583df4fa8625cec3124151454becf63f" name="gga3f6ff6abe155494dc72eff08c90af002a583df4fa8625cec3124151454becf63f"></a>CC_Mqtt5TopicAliasPreference_ForceTopicWithAlias </td><td class="fielddoc"><p>Force sending both topic string and its numeric alias. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3f6ff6abe155494dc72eff08c90af002aead576e251681dea5dc38ae2285a0adc" name="gga3f6ff6abe155494dc72eff08c90af002aead576e251681dea5dc38ae2285a0adc"></a>CC_Mqtt5TopicAliasPreference_ValuesLimit </td><td class="fielddoc"><p>Limit for the values. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga9fe48afc42867e3eb9cbfcf26d0e71da" name="ga9fe48afc42867e3eb9cbfcf26d0e71da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9fe48afc42867e3eb9cbfcf26d0e71da">◆ </a></span>cc_mqtt5_client_publish_add_user_prop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> cc_mqtt5_client_publish_add_user_prop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a> </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structCC__Mqtt5UserProp.html">CC_Mqtt5UserProp</a> * </td>
<td class="paramname"><em>prop</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add user property to the configuration of the "publish" operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__publish.html#ga8ba52035a9ea815cbc65592d93bfc1cf">cc_mqtt5_client_publish_prepare()</a> function. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">prop</td><td>Single user property info. Must NOT be NULL. Does not need to be preserved after invocation. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code of the call. </dd></dl>
</div>
</div>
<a id="gad3e4a970267a4634242cda4655b86ddc" name="gad3e4a970267a4634242cda4655b86ddc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad3e4a970267a4634242cda4655b86ddc">◆ </a></span>cc_mqtt5_client_publish_cancel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> cc_mqtt5_client_publish_cancel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a> </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Cancel the allocated "publish" operation. </p>
<p>In case the <a class="el" href="group__publish.html#gaf19c2d2953ee67a413877681fcf8fcc9">cc_mqtt5_client_publish_send()</a> function was successfully called before, the operation is cancelled <b>without</b> callback invocation. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__publish.html#ga8ba52035a9ea815cbc65592d93bfc1cf">cc_mqtt5_client_publish_prepare()</a> function. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code of the call. </dd></dl>
<dl class="section post"><dt>Postcondition</dt><dd>The handle of the "publish" operation is no longer valid and must be discarded. </dd></dl>
</div>
</div>
<a id="ga26d76d06ea71b80772de903d0418ec15" name="ga26d76d06ea71b80772de903d0418ec15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga26d76d06ea71b80772de903d0418ec15">◆ </a></span>cc_mqtt5_client_publish_config_basic()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> cc_mqtt5_client_publish_config_basic </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a> </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structCC__Mqtt5PublishBasicConfig.html">CC_Mqtt5PublishBasicConfig</a> * </td>
<td class="paramname"><em>config</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Perform basic configuration of the "publish" operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__publish.html#ga8ba52035a9ea815cbc65592d93bfc1cf">cc_mqtt5_client_publish_prepare()</a> function. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">config</td><td>Basic configuration structure. Must NOT be NULL. Does not need to be preserved after invocation. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code of the call. </dd></dl>
<dl class="section post"><dt>Postcondition</dt><dd>Some of the properties can get assigned regardless of the return value. </dd></dl>
<dl class="section pre"><dt>Precondition</dt><dd>Mustn't be called more than once for a single "publish" operation when "topic alias" can be used. </dd></dl>
</div>
</div>
<a id="gaae32b8550c3448c54d7fb373ba2214ac" name="gaae32b8550c3448c54d7fb373ba2214ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaae32b8550c3448c54d7fb373ba2214ac">◆ </a></span>cc_mqtt5_client_publish_config_extra()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> cc_mqtt5_client_publish_config_extra </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a> </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structCC__Mqtt5PublishExtraConfig.html">CC_Mqtt5PublishExtraConfig</a> * </td>
<td class="paramname"><em>config</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Perform extra properties configuration of the "publish" operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__publish.html#ga8ba52035a9ea815cbc65592d93bfc1cf">cc_mqtt5_client_publish_prepare()</a> function. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">config</td><td>Extra properties configuration structure. Must NOT be NULL. Does not need to be preserved after invocation. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code of the call. </dd></dl>
<dl class="section pre"><dt>Precondition</dt><dd>Mustn't be called more than once for a single "publish" operation. </dd></dl>
<dl class="section post"><dt>Postcondition</dt><dd>Some of the properties can get assigned regardless of the return value. </dd></dl>
</div>
</div>
<a id="ga8db7a1a3d48471f8af354ca64dd5d6e9" name="ga8db7a1a3d48471f8af354ca64dd5d6e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8db7a1a3d48471f8af354ca64dd5d6e9">◆ </a></span>cc_mqtt5_client_publish_count()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned cc_mqtt5_client_publish_count </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__client.html#ga6c225736aebda7ec79fca5701036ed15">CC_Mqtt5ClientHandle</a> </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get amount incomplete "publish" operations. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__client.html#gaa955f88ddca4c7b695074312b5a8cbee">cc_mqtt5_client_alloc()</a> function. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Amount of publish operations that have been prepared before, and are still incomplete. </dd></dl>
</div>
</div>
<a id="ga3f05f5d3b412ce6bd4fa724afecbee4e" name="ga3f05f5d3b412ce6bd4fa724afecbee4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3f05f5d3b412ce6bd4fa724afecbee4e">◆ </a></span>cc_mqtt5_client_publish_full()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> cc_mqtt5_client_publish_full </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__client.html#ga6c225736aebda7ec79fca5701036ed15">CC_Mqtt5ClientHandle</a> </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structCC__Mqtt5PublishBasicConfig.html">CC_Mqtt5PublishBasicConfig</a> * </td>
<td class="paramname"><em>basicConfig</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structCC__Mqtt5PublishExtraConfig.html">CC_Mqtt5PublishExtraConfig</a> * </td>
<td class="paramname"><em>extraConfig</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__publish.html#ga7911ab79b27c77d887fb2fd491ab5c42">CC_Mqtt5PublishCompleteCb</a> </td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>cbData</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Prepare, configure, and send "publish" request in one go (full version) </p>
<p>Abstracts away sequence of the following functions invocation: </p><ul>
<li><a class="el" href="group__publish.html#ga8ba52035a9ea815cbc65592d93bfc1cf">cc_mqtt5_client_publish_prepare()</a> </li>
<li><a class="el" href="group__publish.html#ga26d76d06ea71b80772de903d0418ec15">cc_mqtt5_client_publish_config_basic()</a> </li>
<li><a class="el" href="group__publish.html#gaae32b8550c3448c54d7fb373ba2214ac">cc_mqtt5_client_publish_config_extra()</a> </li>
<li><a class="el" href="group__publish.html#gaf19c2d2953ee67a413877681fcf8fcc9">cc_mqtt5_client_publish_send()</a></li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__client.html#gaa955f88ddca4c7b695074312b5a8cbee">cc_mqtt5_client_alloc()</a> function. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">basicConfig</td><td>Basic configuration. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">extraConfig</td><td>Extra configuration. Can be NULL. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cb</td><td>Callback to be invoked when "publish" operation is complete. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cbData</td><td>Pointer to any user data structure. It will passed as one of the parameters in callback invocation. May be NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code of the call. </dd></dl>
</div>
</div>
<a id="ga5389ff87af1e2982b0fd9122489b4ffd" name="ga5389ff87af1e2982b0fd9122489b4ffd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5389ff87af1e2982b0fd9122489b4ffd">◆ </a></span>cc_mqtt5_client_publish_get_ordering()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__publish.html#gac670d5217c079165d7c438648e28215f">CC_Mqtt5PublishOrdering</a> cc_mqtt5_client_publish_get_ordering </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__client.html#ga6c225736aebda7ec79fca5701036ed15">CC_Mqtt5ClientHandle</a> </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the configured the publish operations ordering. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__publish.html#ga8ba52035a9ea815cbc65592d93bfc1cf">cc_mqtt5_client_publish_prepare()</a> function. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Current ordering configuraiton. </dd></dl>
</div>
</div>
<a id="gac4cd4b0346ab8c622bc962b1a2f6386e" name="gac4cd4b0346ab8c622bc962b1a2f6386e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac4cd4b0346ab8c622bc962b1a2f6386e">◆ </a></span>cc_mqtt5_client_publish_get_resend_attempts()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned cc_mqtt5_client_publish_get_resend_attempts </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a> </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the configured the amount of resend attempts for the "publish" operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__publish.html#ga8ba52035a9ea815cbc65592d93bfc1cf">cc_mqtt5_client_publish_prepare()</a> function. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Configured amount of resend attempts. </dd></dl>
</div>
</div>
<a id="ga27189d64a90fa6c190848467a5237023" name="ga27189d64a90fa6c190848467a5237023"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga27189d64a90fa6c190848467a5237023">◆ </a></span>cc_mqtt5_client_publish_get_response_timeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned cc_mqtt5_client_publish_get_response_timeout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a> </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the configured the broker response timeout for the "publish" operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__publish.html#ga8ba52035a9ea815cbc65592d93bfc1cf">cc_mqtt5_client_publish_prepare()</a> function. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Response timeout duration in <b>milliseconds</b>. </dd></dl>
</div>
</div>
<a id="gaa2dd7ba8568d1cc308c366923f15c06c" name="gaa2dd7ba8568d1cc308c366923f15c06c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa2dd7ba8568d1cc308c366923f15c06c">◆ </a></span>cc_mqtt5_client_publish_init_config_basic()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cc_mqtt5_client_publish_init_config_basic </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structCC__Mqtt5PublishBasicConfig.html">CC_Mqtt5PublishBasicConfig</a> * </td>
<td class="paramname"><em>config</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Intialize the <a class="el" href="structCC__Mqtt5PublishBasicConfig.html">CC_Mqtt5PublishBasicConfig</a> configuration structure. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">config</td><td>Configuration structure. Must not be NULL. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga3364b7d98f39c4c17a88e9f74d76326d" name="ga3364b7d98f39c4c17a88e9f74d76326d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3364b7d98f39c4c17a88e9f74d76326d">◆ </a></span>cc_mqtt5_client_publish_init_config_extra()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cc_mqtt5_client_publish_init_config_extra </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structCC__Mqtt5PublishExtraConfig.html">CC_Mqtt5PublishExtraConfig</a> * </td>
<td class="paramname"><em>config</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Intialize the <a class="el" href="structCC__Mqtt5PublishExtraConfig.html">CC_Mqtt5PublishExtraConfig</a> configuration structure. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">config</td><td>Configuration structure. Must not be NULL. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga8ba52035a9ea815cbc65592d93bfc1cf" name="ga8ba52035a9ea815cbc65592d93bfc1cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8ba52035a9ea815cbc65592d93bfc1cf">◆ </a></span>cc_mqtt5_client_publish_prepare()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a> cc_mqtt5_client_publish_prepare </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__client.html#ga6c225736aebda7ec79fca5701036ed15">CC_Mqtt5ClientHandle</a> </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> * </td>
<td class="paramname"><em>ec</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Prepare "publish" operation. </p>
<p>For successful operation the client needs to be in the "connected" state. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__client.html#gaa955f88ddca4c7b695074312b5a8cbee">cc_mqtt5_client_alloc()</a> function. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">ec</td><td>Error code reporting result of the operation. Can be NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Handle of the "publish" operation, will be NULL in case of failure. To analyze the reason failure use "ec" output parameter. </dd></dl>
<dl class="section post"><dt>Postcondition</dt><dd>The "publish" operation is allocated, use either <a class="el" href="group__publish.html#gaf19c2d2953ee67a413877681fcf8fcc9">cc_mqtt5_client_publish_send()</a> or <a class="el" href="group__publish.html#gad3e4a970267a4634242cda4655b86ddc">cc_mqtt5_client_publish_cancel()</a> to prevent memory leaks. </dd></dl>
</div>
</div>
<a id="gaf19c2d2953ee67a413877681fcf8fcc9" name="gaf19c2d2953ee67a413877681fcf8fcc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf19c2d2953ee67a413877681fcf8fcc9">◆ </a></span>cc_mqtt5_client_publish_send()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> cc_mqtt5_client_publish_send </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a> </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__publish.html#ga7911ab79b27c77d887fb2fd491ab5c42">CC_Mqtt5PublishCompleteCb</a> </td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>cbData</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send the configured "publish" operation to broker. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__publish.html#ga8ba52035a9ea815cbc65592d93bfc1cf">cc_mqtt5_client_publish_prepare()</a> function. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cb</td><td>Callback to be invoked when "publish" operation is complete, can be NULL. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cbData</td><td>Pointer to any user data structure. It will passed as one of the parameters in callback invocation. Can be NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code of the call. </dd></dl>
<dl class="section post"><dt>Postcondition</dt><dd>The handle of the "publish" operation can be discarded. </dd>
<dd>
The provided callback will be invoked when the "publish" operation is complete <b> if and only if</b> the function returns <a class="el" href="group__global.html#ggac9c64dc7d5a785e8b22d7faaaf6f9beaa8f6454b1f4f259f82322e3b5517a4d63">CC_Mqtt5ErrorCode_Success</a>. </dd></dl>
</div>
</div>
<a id="ga4f2facec3ef1b1150ad33f6241b9c7b4" name="ga4f2facec3ef1b1150ad33f6241b9c7b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4f2facec3ef1b1150ad33f6241b9c7b4">◆ </a></span>cc_mqtt5_client_publish_set_ordering()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> cc_mqtt5_client_publish_set_ordering </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__client.html#ga6c225736aebda7ec79fca5701036ed15">CC_Mqtt5ClientHandle</a> </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__publish.html#gac670d5217c079165d7c438648e28215f">CC_Mqtt5PublishOrdering</a> </td>
<td class="paramname"><em>ordering</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Configure the ordering of the published messages. </p>
<p>The ordering configuration is expected to be performed before any "publish" operation is issued. The configuration is persistent between re-connects. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__publish.html#ga8ba52035a9ea815cbc65592d93bfc1cf">cc_mqtt5_client_publish_prepare()</a> function. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ordering</td><td>Ordering configuration. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code of the call. </dd></dl>
</div>
</div>
<a id="gae8e04a144f923f3e5829c3522b1f22ba" name="gae8e04a144f923f3e5829c3522b1f22ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae8e04a144f923f3e5829c3522b1f22ba">◆ </a></span>cc_mqtt5_client_publish_set_resend_attempts()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> cc_mqtt5_client_publish_set_resend_attempts </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a> </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>attempts</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Configure the amount of attempts to resend "publish" operation until the acknowledgement is received. </p>
<p>When resending a second and further time, the <b>DUP</b> flags is set in the <b>PUBLISH</b> message to indicate duplicate. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__publish.html#ga8ba52035a9ea815cbc65592d93bfc1cf">cc_mqtt5_client_publish_prepare()</a> function. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">attempts</td><td>Amount of resend attempts. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code of the call. </dd></dl>
</div>
</div>
<a id="ga8d1bfed81a79f8460f6cc679bdd157cd" name="ga8d1bfed81a79f8460f6cc679bdd157cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8d1bfed81a79f8460f6cc679bdd157cd">◆ </a></span>cc_mqtt5_client_publish_set_response_timeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> cc_mqtt5_client_publish_set_response_timeout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a> </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>ms</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Configure the broker response timeout for the "publish" operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__publish.html#ga8ba52035a9ea815cbc65592d93bfc1cf">cc_mqtt5_client_publish_prepare()</a> function. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ms</td><td>Response timeout duration in <b>milliseconds</b>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code of the call. </dd></dl>
</div>
</div>
<a id="ga4dec892b420aa6bc0a036986c81e9d4c" name="ga4dec892b420aa6bc0a036986c81e9d4c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4dec892b420aa6bc0a036986c81e9d4c">◆ </a></span>cc_mqtt5_client_publish_simple()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__global.html#gac9c64dc7d5a785e8b22d7faaaf6f9bea">CC_Mqtt5ErrorCode</a> cc_mqtt5_client_publish_simple </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__client.html#ga6c225736aebda7ec79fca5701036ed15">CC_Mqtt5ClientHandle</a> </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structCC__Mqtt5PublishBasicConfig.html">CC_Mqtt5PublishBasicConfig</a> * </td>
<td class="paramname"><em>basicConfig</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__publish.html#ga7911ab79b27c77d887fb2fd491ab5c42">CC_Mqtt5PublishCompleteCb</a> </td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>cbData</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Prepare, configure, and send "publish" request in one go (simple version) </p>
<p>Abstracts away sequence of the following functions invocation: </p><ul>
<li><a class="el" href="group__publish.html#ga8ba52035a9ea815cbc65592d93bfc1cf">cc_mqtt5_client_publish_prepare()</a> </li>
<li><a class="el" href="group__publish.html#ga26d76d06ea71b80772de903d0418ec15">cc_mqtt5_client_publish_config_basic()</a> </li>
<li><a class="el" href="group__publish.html#gaf19c2d2953ee67a413877681fcf8fcc9">cc_mqtt5_client_publish_send()</a></li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__client.html#gaa955f88ddca4c7b695074312b5a8cbee">cc_mqtt5_client_alloc()</a> function. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">basicConfig</td><td>Basic configuration. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cb</td><td>Callback to be invoked when "publish" operation is complete. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cbData</td><td>Pointer to any user data structure. It will passed as one of the parameters in callback invocation. May be NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code of the call. </dd></dl>
</div>
</div>
<a id="gaeec796c480e4d7b8384aca93cf0396cb" name="gaeec796c480e4d7b8384aca93cf0396cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaeec796c480e4d7b8384aca93cf0396cb">◆ </a></span>cc_mqtt5_client_publish_was_initiated()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool cc_mqtt5_client_publish_was_initiated </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__publish.html#gabb1e556a5d03323a84209dcdc57a63f8">CC_Mqtt5PublishHandle</a> </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether the "publish" operation was actually initiated (PUBLISH was sent) </p>
<p>In case the amount of outgoing publish messages exceeds the "Receive Maximum" limit set by the broker, or due to message ordering configuration, the requested "publish" operation can be paused. This API call checks whether the <b>PUBLISH</b> message was already sent to the broker. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle returned by <a class="el" href="group__publish.html#ga8ba52035a9ea815cbc65592d93bfc1cf">cc_mqtt5_client_publish_prepare()</a> function. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><b>true</b> in case <b>PUBLISH</b> message has already been sent. </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>