structMQTTClients.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160
  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: MQTTClients 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">MQTTClients Struct Reference</div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <div class="dynheader">
  70. Collaboration diagram for MQTTClients:</div>
  71. <div class="dyncontent">
  72. <div class="center"><img src="structMQTTClients__coll__graph.png" border="0" usemap="#MQTTClients_coll__map" alt="Collaboration graph"/></div>
  73. <map name="MQTTClients_coll__map" id="MQTTClients_coll__map">
  74. <area shape="rect" title=" " alt="" coords="383,349,482,376"/>
  75. <area shape="rect" href="structClients.html" title="Data related to one client." alt="" coords="349,260,412,287"/>
  76. <area shape="rect" href="structMQTTClient__persistence.html" title="A structure containing the function pointers to a persistence implementation and the context or state..." alt="" coords="5,127,172,153"/>
  77. <area shape="rect" href="structwillMessages.html" title="Client will message data." alt="" coords="197,127,298,153"/>
  78. <area shape="rect" href="structnetworkHandles.html" title=" " alt="" coords="323,127,439,153"/>
  79. <area shape="rect" href="structMQTTClient__nameValue.html" title="MQTTClient_libraryInfo is used to store details relating to the currently used library such as the ve..." alt="" coords="281,7,445,33"/>
  80. <area shape="rect" href="structList.html" title="Structure to hold all data for one list." alt="" coords="463,127,507,153"/>
  81. <area shape="rect" href="structListElementStruct.html" title="Structure to hold all data for one list element." alt="" coords="469,7,596,33"/>
  82. <area shape="rect" href="structMQTTPacket.html" title="Data for a packet with header only." alt="" coords="475,260,575,287"/>
  83. <area shape="rect" href="unionHeader.html" title="Bitfields for the MQTT header byte." alt="" coords="531,127,595,153"/>
  84. </map>
  85. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  86. <table class="memberdecls">
  87. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  88. Data Fields</h2></td></tr>
  89. <tr class="memitem:a2be60584b6cb7bbb7a53ce78af83afcc"><td class="memItemLeft" align="right" valign="top"><a id="a2be60584b6cb7bbb7a53ce78af83afcc"></a>
  90. char *&#160;</td><td class="memItemRight" valign="bottom"><b>serverURI</b></td></tr>
  91. <tr class="separator:a2be60584b6cb7bbb7a53ce78af83afcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a3d1982f0ad7958a7480b3acafe050126"><td class="memItemLeft" align="right" valign="top"><a id="a3d1982f0ad7958a7480b3acafe050126"></a>
  93. const char *&#160;</td><td class="memItemRight" valign="bottom"><b>currentServerURI</b></td></tr>
  94. <tr class="separator:a3d1982f0ad7958a7480b3acafe050126"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:a245e48409216156b60f29e590fa179f6"><td class="memItemLeft" align="right" valign="top"><a id="a245e48409216156b60f29e590fa179f6"></a>
  96. int&#160;</td><td class="memItemRight" valign="bottom"><b>websocket</b></td></tr>
  97. <tr class="separator:a245e48409216156b60f29e590fa179f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a8d704b075c4112efb12d64ef9f13c196"><td class="memItemLeft" align="right" valign="top"><a id="a8d704b075c4112efb12d64ef9f13c196"></a>
  99. <a class="el" href="structClients.html">Clients</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>c</b></td></tr>
  100. <tr class="separator:a8d704b075c4112efb12d64ef9f13c196"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a9a1cee5ac94e97bad9706a28c1ae96ed"><td class="memItemLeft" align="right" valign="top"><a id="a9a1cee5ac94e97bad9706a28c1ae96ed"></a>
  102. MQTTClient_connectionLost *&#160;</td><td class="memItemRight" valign="bottom"><b>cl</b></td></tr>
  103. <tr class="separator:a9a1cee5ac94e97bad9706a28c1ae96ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:ae090570cf36be52a9503329c94481db3"><td class="memItemLeft" align="right" valign="top"><a id="ae090570cf36be52a9503329c94481db3"></a>
  105. MQTTClient_messageArrived *&#160;</td><td class="memItemRight" valign="bottom"><b>ma</b></td></tr>
  106. <tr class="separator:ae090570cf36be52a9503329c94481db3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:ac9f31ff6b69cb96a658fc48f564cb45c"><td class="memItemLeft" align="right" valign="top"><a id="ac9f31ff6b69cb96a658fc48f564cb45c"></a>
  108. MQTTClient_deliveryComplete *&#160;</td><td class="memItemRight" valign="bottom"><b>dc</b></td></tr>
  109. <tr class="separator:ac9f31ff6b69cb96a658fc48f564cb45c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:acb6d36b0317e257321e081e19bcf3763"><td class="memItemLeft" align="right" valign="top"><a id="acb6d36b0317e257321e081e19bcf3763"></a>
  111. void *&#160;</td><td class="memItemRight" valign="bottom"><b>context</b></td></tr>
  112. <tr class="separator:acb6d36b0317e257321e081e19bcf3763"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:aec93a32b355d3acb39746f4ef254b71f"><td class="memItemLeft" align="right" valign="top"><a id="aec93a32b355d3acb39746f4ef254b71f"></a>
  114. MQTTClient_disconnected *&#160;</td><td class="memItemRight" valign="bottom"><b>disconnected</b></td></tr>
  115. <tr class="separator:aec93a32b355d3acb39746f4ef254b71f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a18c0bc86e8147576ddbf25325395de1e"><td class="memItemLeft" align="right" valign="top"><a id="a18c0bc86e8147576ddbf25325395de1e"></a>
  117. void *&#160;</td><td class="memItemRight" valign="bottom"><b>disconnected_context</b></td></tr>
  118. <tr class="separator:a18c0bc86e8147576ddbf25325395de1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:ab73d623e10960b3e3b945f682b2b7dcc"><td class="memItemLeft" align="right" valign="top"><a id="ab73d623e10960b3e3b945f682b2b7dcc"></a>
  120. MQTTClient_published *&#160;</td><td class="memItemRight" valign="bottom"><b>published</b></td></tr>
  121. <tr class="separator:ab73d623e10960b3e3b945f682b2b7dcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:af09f19437c1db2fde09fd679a13cfbdc"><td class="memItemLeft" align="right" valign="top"><a id="af09f19437c1db2fde09fd679a13cfbdc"></a>
  123. void *&#160;</td><td class="memItemRight" valign="bottom"><b>published_context</b></td></tr>
  124. <tr class="separator:af09f19437c1db2fde09fd679a13cfbdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:ad328a710004fd067c760f2b8218a1204"><td class="memItemLeft" align="right" valign="top"><a id="ad328a710004fd067c760f2b8218a1204"></a>
  126. sem_type&#160;</td><td class="memItemRight" valign="bottom"><b>connect_sem</b></td></tr>
  127. <tr class="separator:ad328a710004fd067c760f2b8218a1204"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a7b497e5cc64663f1635a742bc8d08e51"><td class="memItemLeft" align="right" valign="top"><a id="a7b497e5cc64663f1635a742bc8d08e51"></a>
  129. int&#160;</td><td class="memItemRight" valign="bottom"><b>rc</b></td></tr>
  130. <tr class="separator:a7b497e5cc64663f1635a742bc8d08e51"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:ae1ec037358f7151a74bfce0dee9f7d77"><td class="memItemLeft" align="right" valign="top"><a id="ae1ec037358f7151a74bfce0dee9f7d77"></a>
  132. sem_type&#160;</td><td class="memItemRight" valign="bottom"><b>connack_sem</b></td></tr>
  133. <tr class="separator:ae1ec037358f7151a74bfce0dee9f7d77"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a996942b1f26e0ca88fd642a0b689b72f"><td class="memItemLeft" align="right" valign="top"><a id="a996942b1f26e0ca88fd642a0b689b72f"></a>
  135. sem_type&#160;</td><td class="memItemRight" valign="bottom"><b>suback_sem</b></td></tr>
  136. <tr class="separator:a996942b1f26e0ca88fd642a0b689b72f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:ae6052e767612b109ebe09edc8d65f1d4"><td class="memItemLeft" align="right" valign="top"><a id="ae6052e767612b109ebe09edc8d65f1d4"></a>
  138. sem_type&#160;</td><td class="memItemRight" valign="bottom"><b>unsuback_sem</b></td></tr>
  139. <tr class="separator:ae6052e767612b109ebe09edc8d65f1d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:a38385c37fe35764389bda86835efc51f"><td class="memItemLeft" align="right" valign="top"><a id="a38385c37fe35764389bda86835efc51f"></a>
  141. <a class="el" href="structMQTTPacket.html">MQTTPacket</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>pack</b></td></tr>
  142. <tr class="separator:a38385c37fe35764389bda86835efc51f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a939afe7cbe07766ff19f0af169a55c3f"><td class="memItemLeft" align="right" valign="top"><a id="a939afe7cbe07766ff19f0af169a55c3f"></a>
  144. unsigned long&#160;</td><td class="memItemRight" valign="bottom"><b>commandTimeout</b></td></tr>
  145. <tr class="separator:a939afe7cbe07766ff19f0af169a55c3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. </table>
  147. <hr/>The documentation for this struct was generated from the following file:<ul>
  148. <li><a class="el" href="MQTTClient_8c.html">MQTTClient.c</a></li>
  149. </ul>
  150. </div><!-- contents -->
  151. <!-- start footer part -->
  152. <hr class="footer"/><address class="footer"><small>
  153. 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">
  154. <img class="footer" src="doxygen.png" alt="doxygen"/>
  155. </a> 1.8.17
  156. </small></address>
  157. </body>
  158. </html>