structMessages.html 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>MQTT C Client Libraries Internals: Messages Struct Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectlogo"><img alt="Logo" src="pahologo.png"/></td>
  24. <td id="projectalign" style="padding-left: 0.5em;">
  25. <div id="projectname">MQTT C Client Libraries Internals
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. </div><!-- top -->
  62. <div class="header">
  63. <div class="summary">
  64. <a href="#pub-attribs">Data Fields</a> </div>
  65. <div class="headertitle">
  66. <div class="title">Messages Struct Reference</div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p>Client publication message data.
  70. <a href="structMessages.html#details">More...</a></p>
  71. <p><code>#include &lt;Clients.h&gt;</code></p>
  72. <div class="dynheader">
  73. Collaboration diagram for Messages:</div>
  74. <div class="dyncontent">
  75. <div class="center"><img src="structMessages__coll__graph.png" border="0" usemap="#Messages_coll__map" alt="Collaboration graph"/></div>
  76. <map name="Messages_coll__map" id="Messages_coll__map">
  77. <area shape="rect" title="Client publication message data." alt="" coords="48,288,131,315"/>
  78. <area shape="rect" href="structPublications.html" title="Stored publication data to minimize copying." alt="" coords="5,199,99,225"/>
  79. <area shape="rect" href="structMQTTProperties.html" title="MQTT version 5 property list." alt="" coords="123,199,242,225"/>
  80. <area shape="rect" href="structMQTTProperty.html" title="Structure to hold an MQTT version 5 property of any type." alt="" coords="129,109,236,136"/>
  81. <area shape="rect" href="structMQTTLenString.html" title="The data for a length delimited string." alt="" coords="125,5,240,32"/>
  82. </map>
  83. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  84. <table class="memberdecls">
  85. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  86. Data Fields</h2></td></tr>
  87. <tr class="memitem:aff6367a2ccd7ff6727edfda47aeecb34"><td class="memItemLeft" align="right" valign="top"><a id="aff6367a2ccd7ff6727edfda47aeecb34"></a>
  88. int&#160;</td><td class="memItemRight" valign="bottom"><b>qos</b></td></tr>
  89. <tr class="separator:aff6367a2ccd7ff6727edfda47aeecb34"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a6edd5caa101f06d6d1faf5043a83aaf6"><td class="memItemLeft" align="right" valign="top"><a id="a6edd5caa101f06d6d1faf5043a83aaf6"></a>
  91. int&#160;</td><td class="memItemRight" valign="bottom"><b>retain</b></td></tr>
  92. <tr class="separator:a6edd5caa101f06d6d1faf5043a83aaf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a75683f46015b3c0daadea37daaa1a9b1"><td class="memItemLeft" align="right" valign="top"><a id="a75683f46015b3c0daadea37daaa1a9b1"></a>
  94. int&#160;</td><td class="memItemRight" valign="bottom"><b>msgid</b></td></tr>
  95. <tr class="separator:a75683f46015b3c0daadea37daaa1a9b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a838d1fdebf5418ffa466a0829e7c1d6b"><td class="memItemLeft" align="right" valign="top"><a id="a838d1fdebf5418ffa466a0829e7c1d6b"></a>
  97. int&#160;</td><td class="memItemRight" valign="bottom"><b>MQTTVersion</b></td></tr>
  98. <tr class="separator:a838d1fdebf5418ffa466a0829e7c1d6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:ab678418724e0c555e3ea41b493ef00f5"><td class="memItemLeft" align="right" valign="top"><a id="ab678418724e0c555e3ea41b493ef00f5"></a>
  100. <a class="el" href="structMQTTProperties.html">MQTTProperties</a>&#160;</td><td class="memItemRight" valign="bottom"><b>properties</b></td></tr>
  101. <tr class="separator:ab678418724e0c555e3ea41b493ef00f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:aad0e7b7941963e43d16e470d9a95c5bd"><td class="memItemLeft" align="right" valign="top"><a id="aad0e7b7941963e43d16e470d9a95c5bd"></a>
  103. <a class="el" href="structPublications.html">Publications</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>publish</b></td></tr>
  104. <tr class="separator:aad0e7b7941963e43d16e470d9a95c5bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a6887116ad0e87a70b2972e412d60bbea"><td class="memItemLeft" align="right" valign="top"><a id="a6887116ad0e87a70b2972e412d60bbea"></a>
  106. START_TIME_TYPE&#160;</td><td class="memItemRight" valign="bottom"><b>lastTouch</b></td></tr>
  107. <tr class="separator:a6887116ad0e87a70b2972e412d60bbea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:aa31b6d8af2e0230eccdcc6ee7f2cefb1"><td class="memItemLeft" align="right" valign="top"><a id="aa31b6d8af2e0230eccdcc6ee7f2cefb1"></a>
  109. char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMessages.html#aa31b6d8af2e0230eccdcc6ee7f2cefb1">nextMessageType</a></td></tr>
  110. <tr class="memdesc:aa31b6d8af2e0230eccdcc6ee7f2cefb1"><td class="mdescLeft">&#160;</td><td class="mdescRight"><blockquote class="doxtable">
  111. <p>used for retry and expiry </p>
  112. </blockquote>
  113. <br /></td></tr>
  114. <tr class="separator:aa31b6d8af2e0230eccdcc6ee7f2cefb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a4751604bf85bccbff2273a069f976679"><td class="memItemLeft" align="right" valign="top"><a id="a4751604bf85bccbff2273a069f976679"></a>
  116. int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMessages.html#a4751604bf85bccbff2273a069f976679">len</a></td></tr>
  117. <tr class="memdesc:a4751604bf85bccbff2273a069f976679"><td class="mdescLeft">&#160;</td><td class="mdescRight"><blockquote class="doxtable">
  118. <p>PUBREC, PUBREL, PUBCOMP </p>
  119. </blockquote>
  120. <br /></td></tr>
  121. <tr class="separator:a4751604bf85bccbff2273a069f976679"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. </table>
  123. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  124. <div class="textblock"><p>Client publication message data. </p>
  125. </div><hr/>The documentation for this struct was generated from the following file:<ul>
  126. <li>Clients.h</li>
  127. </ul>
  128. </div><!-- contents -->
  129. <!-- start footer part -->
  130. <hr class="footer"/><address class="footer"><small>
  131. Generated on Thu Sep 29 2022 11:34:46 for MQTT C Client Libraries Internals by &#160;<a href="http://www.doxygen.org/index.html">
  132. <img class="footer" src="doxygen.png" alt="doxygen"/>
  133. </a> 1.8.17
  134. </small></address>
  135. </body>
  136. </html>