structClients.html 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248
  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: Clients 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">Clients Struct Reference</div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p>Data related to one client.
  70. <a href="structClients.html#details">More...</a></p>
  71. <p><code>#include &lt;Clients.h&gt;</code></p>
  72. <div class="dynheader">
  73. Collaboration diagram for Clients:</div>
  74. <div class="dyncontent">
  75. <div class="center"><img src="structClients__coll__graph.png" border="0" usemap="#Clients_coll__map" alt="Collaboration graph"/></div>
  76. <map name="Clients_coll__map" id="Clients_coll__map">
  77. <area shape="rect" title="Data related to one client." alt="" coords="263,260,325,287"/>
  78. <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"/>
  79. <area shape="rect" href="structwillMessages.html" title="Client will message data." alt="" coords="197,127,298,153"/>
  80. <area shape="rect" href="structnetworkHandles.html" title=" " alt="" coords="323,127,439,153"/>
  81. <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"/>
  82. <area shape="rect" href="structList.html" title="Structure to hold all data for one list." alt="" coords="463,127,507,153"/>
  83. <area shape="rect" href="structListElementStruct.html" title="Structure to hold all data for one list element." alt="" coords="469,7,596,33"/>
  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:aab6a37dbb279f1f1819bd89f75695e92"><td class="memItemLeft" align="right" valign="top"><a id="aab6a37dbb279f1f1819bd89f75695e92"></a>
  90. char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#aab6a37dbb279f1f1819bd89f75695e92">clientID</a></td></tr>
  91. <tr class="memdesc:aab6a37dbb279f1f1819bd89f75695e92"><td class="mdescLeft">&#160;</td><td class="mdescRight">the string id of the client <br /></td></tr>
  92. <tr class="separator:aab6a37dbb279f1f1819bd89f75695e92"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:af8cc24a8d289b4950b7c929b03cba031"><td class="memItemLeft" align="right" valign="top"><a id="af8cc24a8d289b4950b7c929b03cba031"></a>
  94. const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#af8cc24a8d289b4950b7c929b03cba031">username</a></td></tr>
  95. <tr class="memdesc:af8cc24a8d289b4950b7c929b03cba031"><td class="mdescLeft">&#160;</td><td class="mdescRight">MQTT v3.1 user name. <br /></td></tr>
  96. <tr class="separator:af8cc24a8d289b4950b7c929b03cba031"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a9fc28cb6abab3247752403043c346aa1"><td class="memItemLeft" align="right" valign="top"><a id="a9fc28cb6abab3247752403043c346aa1"></a>
  98. int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a9fc28cb6abab3247752403043c346aa1">passwordlen</a></td></tr>
  99. <tr class="memdesc:a9fc28cb6abab3247752403043c346aa1"><td class="mdescLeft">&#160;</td><td class="mdescRight">MQTT password length. <br /></td></tr>
  100. <tr class="separator:a9fc28cb6abab3247752403043c346aa1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a9f88bf65b015c91ec6ae7bc827513d66"><td class="memItemLeft" align="right" valign="top"><a id="a9f88bf65b015c91ec6ae7bc827513d66"></a>
  102. const void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a9f88bf65b015c91ec6ae7bc827513d66">password</a></td></tr>
  103. <tr class="memdesc:a9f88bf65b015c91ec6ae7bc827513d66"><td class="mdescLeft">&#160;</td><td class="mdescRight">MQTT v3.1 binary password. <br /></td></tr>
  104. <tr class="separator:a9f88bf65b015c91ec6ae7bc827513d66"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a9853b4a06c38478148ab09fe9ccff423"><td class="memItemLeft" align="right" valign="top"><a id="a9853b4a06c38478148ab09fe9ccff423"></a>
  106. unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a9853b4a06c38478148ab09fe9ccff423">cleansession</a>: 1</td></tr>
  107. <tr class="memdesc:a9853b4a06c38478148ab09fe9ccff423"><td class="mdescLeft">&#160;</td><td class="mdescRight">MQTT V3 clean session flag. <br /></td></tr>
  108. <tr class="separator:a9853b4a06c38478148ab09fe9ccff423"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a8e1ca3c305b51f86c29d246a60d0fec2"><td class="memItemLeft" align="right" valign="top"><a id="a8e1ca3c305b51f86c29d246a60d0fec2"></a>
  110. unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a8e1ca3c305b51f86c29d246a60d0fec2">cleanstart</a>: 1</td></tr>
  111. <tr class="memdesc:a8e1ca3c305b51f86c29d246a60d0fec2"><td class="mdescLeft">&#160;</td><td class="mdescRight">MQTT V5 clean start flag. <br /></td></tr>
  112. <tr class="separator:a8e1ca3c305b51f86c29d246a60d0fec2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:adc2f2a83ccacde92ad6b4ee304fc3e6a"><td class="memItemLeft" align="right" valign="top"><a id="adc2f2a83ccacde92ad6b4ee304fc3e6a"></a>
  114. unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#adc2f2a83ccacde92ad6b4ee304fc3e6a">connected</a>: 1</td></tr>
  115. <tr class="memdesc:adc2f2a83ccacde92ad6b4ee304fc3e6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">whether it is currently connected <br /></td></tr>
  116. <tr class="separator:adc2f2a83ccacde92ad6b4ee304fc3e6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a45dde398d2d928794de3886c74c435f6"><td class="memItemLeft" align="right" valign="top"><a id="a45dde398d2d928794de3886c74c435f6"></a>
  118. unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a45dde398d2d928794de3886c74c435f6">good</a>: 1</td></tr>
  119. <tr class="memdesc:a45dde398d2d928794de3886c74c435f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">if we have an error on the socket we turn this off <br /></td></tr>
  120. <tr class="separator:a45dde398d2d928794de3886c74c435f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a87678256217eb18afcd70ba467cbbff5"><td class="memItemLeft" align="right" valign="top"><a id="a87678256217eb18afcd70ba467cbbff5"></a>
  122. unsigned int&#160;</td><td class="memItemRight" valign="bottom"><b>ping_outstanding</b>: 1</td></tr>
  123. <tr class="separator:a87678256217eb18afcd70ba467cbbff5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a121c64145977cb25dfd05a3297a4d6f1"><td class="memItemLeft" align="right" valign="top"><a id="a121c64145977cb25dfd05a3297a4d6f1"></a>
  125. unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a121c64145977cb25dfd05a3297a4d6f1">ping_due</a>: 1</td></tr>
  126. <tr class="memdesc:a121c64145977cb25dfd05a3297a4d6f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">we couldn't send a ping so we should send one when we can <br /></td></tr>
  127. <tr class="separator:a121c64145977cb25dfd05a3297a4d6f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a5d69bc3b13b1be2955cf2606ecc791aa"><td class="memItemLeft" align="right" valign="top"><a id="a5d69bc3b13b1be2955cf2606ecc791aa"></a>
  129. signed int&#160;</td><td class="memItemRight" valign="bottom"><b>connect_state</b>: 4</td></tr>
  130. <tr class="separator:a5d69bc3b13b1be2955cf2606ecc791aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a4e6f0b2b23c1a2b86899c9ca7b06b29b"><td class="memItemLeft" align="right" valign="top"><a id="a4e6f0b2b23c1a2b86899c9ca7b06b29b"></a>
  132. START_TIME_TYPE&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a4e6f0b2b23c1a2b86899c9ca7b06b29b">ping_due_time</a></td></tr>
  133. <tr class="memdesc:a4e6f0b2b23c1a2b86899c9ca7b06b29b"><td class="mdescLeft">&#160;</td><td class="mdescRight">the time at which the ping should have been sent (ping_due) <br /></td></tr>
  134. <tr class="separator:a4e6f0b2b23c1a2b86899c9ca7b06b29b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a8521f3c0d7728e0bac41c1601ca8bbb9"><td class="memItemLeft" align="right" valign="top"><a id="a8521f3c0d7728e0bac41c1601ca8bbb9"></a>
  136. <a class="el" href="structnetworkHandles.html">networkHandles</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a8521f3c0d7728e0bac41c1601ca8bbb9">net</a></td></tr>
  137. <tr class="memdesc:a8521f3c0d7728e0bac41c1601ca8bbb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">network info for this client <br /></td></tr>
  138. <tr class="separator:a8521f3c0d7728e0bac41c1601ca8bbb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:ad0aaa6d9fce1f8196ff859df00716055"><td class="memItemLeft" align="right" valign="top"><a id="ad0aaa6d9fce1f8196ff859df00716055"></a>
  140. int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#ad0aaa6d9fce1f8196ff859df00716055">msgID</a></td></tr>
  141. <tr class="memdesc:ad0aaa6d9fce1f8196ff859df00716055"><td class="mdescLeft">&#160;</td><td class="mdescRight">the MQTT message id <br /></td></tr>
  142. <tr class="separator:ad0aaa6d9fce1f8196ff859df00716055"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a0c9720f6d2df33e40ca5a28ced0036bb"><td class="memItemLeft" align="right" valign="top"><a id="a0c9720f6d2df33e40ca5a28ced0036bb"></a>
  144. int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a0c9720f6d2df33e40ca5a28ced0036bb">keepAliveInterval</a></td></tr>
  145. <tr class="memdesc:a0c9720f6d2df33e40ca5a28ced0036bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">the MQTT keep alive interval <br /></td></tr>
  146. <tr class="separator:a0c9720f6d2df33e40ca5a28ced0036bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a6b2188e352433ff089b1b7d08976a63b"><td class="memItemLeft" align="right" valign="top"><a id="a6b2188e352433ff089b1b7d08976a63b"></a>
  148. int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a6b2188e352433ff089b1b7d08976a63b">retryInterval</a></td></tr>
  149. <tr class="memdesc:a6b2188e352433ff089b1b7d08976a63b"><td class="mdescLeft">&#160;</td><td class="mdescRight">the MQTT retry interval for QoS &gt; 0 <br /></td></tr>
  150. <tr class="separator:a6b2188e352433ff089b1b7d08976a63b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:af0963eb25f36dfafdd29bfc3007181b7"><td class="memItemLeft" align="right" valign="top"><a id="af0963eb25f36dfafdd29bfc3007181b7"></a>
  152. int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#af0963eb25f36dfafdd29bfc3007181b7">maxInflightMessages</a></td></tr>
  153. <tr class="memdesc:af0963eb25f36dfafdd29bfc3007181b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">the max number of inflight outbound messages we allow <br /></td></tr>
  154. <tr class="separator:af0963eb25f36dfafdd29bfc3007181b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:ad593ed8add1448fe1f1e01b4d60f28a7"><td class="memItemLeft" align="right" valign="top"><a id="ad593ed8add1448fe1f1e01b4d60f28a7"></a>
  156. <a class="el" href="structwillMessages.html">willMessages</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#ad593ed8add1448fe1f1e01b4d60f28a7">will</a></td></tr>
  157. <tr class="memdesc:ad593ed8add1448fe1f1e01b4d60f28a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">the MQTT will message, if any <br /></td></tr>
  158. <tr class="separator:ad593ed8add1448fe1f1e01b4d60f28a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:a6e1576ebc386f04d2a70b943677b54d6"><td class="memItemLeft" align="right" valign="top"><a id="a6e1576ebc386f04d2a70b943677b54d6"></a>
  160. <a class="el" href="structList.html">List</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a6e1576ebc386f04d2a70b943677b54d6">inboundMsgs</a></td></tr>
  161. <tr class="memdesc:a6e1576ebc386f04d2a70b943677b54d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">inbound in flight messages <br /></td></tr>
  162. <tr class="separator:a6e1576ebc386f04d2a70b943677b54d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:a1d9f8325aa92c6f65a285e823091bbe1"><td class="memItemLeft" align="right" valign="top"><a id="a1d9f8325aa92c6f65a285e823091bbe1"></a>
  164. <a class="el" href="structList.html">List</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a1d9f8325aa92c6f65a285e823091bbe1">outboundMsgs</a></td></tr>
  165. <tr class="memdesc:a1d9f8325aa92c6f65a285e823091bbe1"><td class="mdescLeft">&#160;</td><td class="mdescRight">outbound in flight messages <br /></td></tr>
  166. <tr class="separator:a1d9f8325aa92c6f65a285e823091bbe1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <tr class="memitem:a46550d6ea8cf3480bb754afa56f516d5"><td class="memItemLeft" align="right" valign="top"><a id="a46550d6ea8cf3480bb754afa56f516d5"></a>
  168. int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a46550d6ea8cf3480bb754afa56f516d5">connect_count</a></td></tr>
  169. <tr class="memdesc:a46550d6ea8cf3480bb754afa56f516d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">the number of outbound messages on reconnect - to ensure we send them all <br /></td></tr>
  170. <tr class="separator:a46550d6ea8cf3480bb754afa56f516d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  171. <tr class="memitem:a02e9acc54d3df8770178f16694c1f405"><td class="memItemLeft" align="right" valign="top"><a id="a02e9acc54d3df8770178f16694c1f405"></a>
  172. int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a02e9acc54d3df8770178f16694c1f405">connect_sent</a></td></tr>
  173. <tr class="memdesc:a02e9acc54d3df8770178f16694c1f405"><td class="mdescLeft">&#160;</td><td class="mdescRight">the current number of outbound messages on reconnect that we've sent <br /></td></tr>
  174. <tr class="separator:a02e9acc54d3df8770178f16694c1f405"><td class="memSeparator" colspan="2">&#160;</td></tr>
  175. <tr class="memitem:a19263eecc43962ac977832e124b4529f"><td class="memItemLeft" align="right" valign="top"><a id="a19263eecc43962ac977832e124b4529f"></a>
  176. <a class="el" href="structList.html">List</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a19263eecc43962ac977832e124b4529f">messageQueue</a></td></tr>
  177. <tr class="memdesc:a19263eecc43962ac977832e124b4529f"><td class="mdescLeft">&#160;</td><td class="mdescRight">inbound complete but undelivered messages <br /></td></tr>
  178. <tr class="separator:a19263eecc43962ac977832e124b4529f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  179. <tr class="memitem:a9495d5b5b191a897c05ea8d298e6d6b5"><td class="memItemLeft" align="right" valign="top"><a id="a9495d5b5b191a897c05ea8d298e6d6b5"></a>
  180. <a class="el" href="structList.html">List</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a9495d5b5b191a897c05ea8d298e6d6b5">outboundQueue</a></td></tr>
  181. <tr class="memdesc:a9495d5b5b191a897c05ea8d298e6d6b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">outbound queued messages <br /></td></tr>
  182. <tr class="separator:a9495d5b5b191a897c05ea8d298e6d6b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  183. <tr class="memitem:a39258afd8678025f6e108ba6e3acbee1"><td class="memItemLeft" align="right" valign="top"><a id="a39258afd8678025f6e108ba6e3acbee1"></a>
  184. unsigned int&#160;</td><td class="memItemRight" valign="bottom"><b>qentry_seqno</b></td></tr>
  185. <tr class="separator:a39258afd8678025f6e108ba6e3acbee1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  186. <tr class="memitem:a1a0ca8e87f5d963ea3ab5c2e7748aaa5"><td class="memItemLeft" align="right" valign="top"><a id="a1a0ca8e87f5d963ea3ab5c2e7748aaa5"></a>
  187. void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a1a0ca8e87f5d963ea3ab5c2e7748aaa5">phandle</a></td></tr>
  188. <tr class="memdesc:a1a0ca8e87f5d963ea3ab5c2e7748aaa5"><td class="mdescLeft">&#160;</td><td class="mdescRight">the persistence handle <br /></td></tr>
  189. <tr class="separator:a1a0ca8e87f5d963ea3ab5c2e7748aaa5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  190. <tr class="memitem:a8745ab9f05600fd3f97bf695e99a7f17"><td class="memItemLeft" align="right" valign="top"><a id="a8745ab9f05600fd3f97bf695e99a7f17"></a>
  191. <a class="el" href="structMQTTClient__persistence.html">MQTTClient_persistence</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a8745ab9f05600fd3f97bf695e99a7f17">persistence</a></td></tr>
  192. <tr class="memdesc:a8745ab9f05600fd3f97bf695e99a7f17"><td class="mdescLeft">&#160;</td><td class="mdescRight">a persistence implementation <br /></td></tr>
  193. <tr class="separator:a8745ab9f05600fd3f97bf695e99a7f17"><td class="memSeparator" colspan="2">&#160;</td></tr>
  194. <tr class="memitem:acb5a2bdb04148e714a123b6a14b34cb9"><td class="memItemLeft" align="right" valign="top"><a id="acb5a2bdb04148e714a123b6a14b34cb9"></a>
  195. <a class="el" href="MQTTClientPersistence_8h.html#ab865640a1cc53b68622004c5a2d29fae">MQTTPersistence_beforeWrite</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#acb5a2bdb04148e714a123b6a14b34cb9">beforeWrite</a></td></tr>
  196. <tr class="memdesc:acb5a2bdb04148e714a123b6a14b34cb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">persistence write callback <br /></td></tr>
  197. <tr class="separator:acb5a2bdb04148e714a123b6a14b34cb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  198. <tr class="memitem:a32899a8e944eef969c834833388fb91e"><td class="memItemLeft" align="right" valign="top"><a id="a32899a8e944eef969c834833388fb91e"></a>
  199. <a class="el" href="MQTTClientPersistence_8h.html#af5a966a574c6ad7a35f1ebb7edd5c1c4">MQTTPersistence_afterRead</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a32899a8e944eef969c834833388fb91e">afterRead</a></td></tr>
  200. <tr class="memdesc:a32899a8e944eef969c834833388fb91e"><td class="mdescLeft">&#160;</td><td class="mdescRight">persistence read callback <br /></td></tr>
  201. <tr class="separator:a32899a8e944eef969c834833388fb91e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  202. <tr class="memitem:a57ec2f443b8de574ede8a62a6a3212db"><td class="memItemLeft" align="right" valign="top"><a id="a57ec2f443b8de574ede8a62a6a3212db"></a>
  203. void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a57ec2f443b8de574ede8a62a6a3212db">beforeWrite_context</a></td></tr>
  204. <tr class="memdesc:a57ec2f443b8de574ede8a62a6a3212db"><td class="mdescLeft">&#160;</td><td class="mdescRight">context to be used with the persistence beforeWrite callbacks <br /></td></tr>
  205. <tr class="separator:a57ec2f443b8de574ede8a62a6a3212db"><td class="memSeparator" colspan="2">&#160;</td></tr>
  206. <tr class="memitem:a429110f440ce0de51d60324fa8b8cc57"><td class="memItemLeft" align="right" valign="top"><a id="a429110f440ce0de51d60324fa8b8cc57"></a>
  207. void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a429110f440ce0de51d60324fa8b8cc57">afterRead_context</a></td></tr>
  208. <tr class="memdesc:a429110f440ce0de51d60324fa8b8cc57"><td class="mdescLeft">&#160;</td><td class="mdescRight">context to be used with the persistence afterRead callback <br /></td></tr>
  209. <tr class="separator:a429110f440ce0de51d60324fa8b8cc57"><td class="memSeparator" colspan="2">&#160;</td></tr>
  210. <tr class="memitem:ae0c3a79f1943071fe9d336014cf5826a"><td class="memItemLeft" align="right" valign="top"><a id="ae0c3a79f1943071fe9d336014cf5826a"></a>
  211. void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#ae0c3a79f1943071fe9d336014cf5826a">context</a></td></tr>
  212. <tr class="memdesc:ae0c3a79f1943071fe9d336014cf5826a"><td class="mdescLeft">&#160;</td><td class="mdescRight">calling context - used when calling disconnect_internal <br /></td></tr>
  213. <tr class="separator:ae0c3a79f1943071fe9d336014cf5826a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  214. <tr class="memitem:a9cb1ad103af7c3aaf00e79037e6befba"><td class="memItemLeft" align="right" valign="top"><a id="a9cb1ad103af7c3aaf00e79037e6befba"></a>
  215. int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a9cb1ad103af7c3aaf00e79037e6befba">MQTTVersion</a></td></tr>
  216. <tr class="memdesc:a9cb1ad103af7c3aaf00e79037e6befba"><td class="mdescLeft">&#160;</td><td class="mdescRight">the version of MQTT being used, 3, 4 or 5 <br /></td></tr>
  217. <tr class="separator:a9cb1ad103af7c3aaf00e79037e6befba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  218. <tr class="memitem:a3ead27f8653d4866faed5d7b711159d1"><td class="memItemLeft" align="right" valign="top"><a id="a3ead27f8653d4866faed5d7b711159d1"></a>
  219. int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a3ead27f8653d4866faed5d7b711159d1">sessionExpiry</a></td></tr>
  220. <tr class="memdesc:a3ead27f8653d4866faed5d7b711159d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">MQTT 5 session expiry. <br /></td></tr>
  221. <tr class="separator:a3ead27f8653d4866faed5d7b711159d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  222. <tr class="memitem:a70540b5d48c05815309215b18de69f8a"><td class="memItemLeft" align="right" valign="top"><a id="a70540b5d48c05815309215b18de69f8a"></a>
  223. char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a70540b5d48c05815309215b18de69f8a">httpProxy</a></td></tr>
  224. <tr class="memdesc:a70540b5d48c05815309215b18de69f8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">HTTP proxy. <br /></td></tr>
  225. <tr class="separator:a70540b5d48c05815309215b18de69f8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  226. <tr class="memitem:a3864bdb9426f9fc646eff80109a831b3"><td class="memItemLeft" align="right" valign="top"><a id="a3864bdb9426f9fc646eff80109a831b3"></a>
  227. char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structClients.html#a3864bdb9426f9fc646eff80109a831b3">httpsProxy</a></td></tr>
  228. <tr class="memdesc:a3864bdb9426f9fc646eff80109a831b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">HTTPS proxy. <br /></td></tr>
  229. <tr class="separator:a3864bdb9426f9fc646eff80109a831b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  230. </table>
  231. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  232. <div class="textblock"><p>Data related to one client. </p>
  233. </div><hr/>The documentation for this struct was generated from the following file:<ul>
  234. <li>Clients.h</li>
  235. </ul>
  236. </div><!-- contents -->
  237. <!-- start footer part -->
  238. <hr class="footer"/><address class="footer"><small>
  239. 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">
  240. <img class="footer" src="doxygen.png" alt="doxygen"/>
  241. </a> 1.8.17
  242. </small></address>
  243. </body>
  244. </html>