structMQTTAsync__connectData.html 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183
  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: MQTTAsync_connectData 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">MQTTAsync_connectData Struct Reference</div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p>The connect options that can be updated before an automatic reconnect.
  70. <a href="structMQTTAsync__connectData.html#details">More...</a></p>
  71. <p><code>#include &lt;MQTTAsync.h&gt;</code></p>
  72. <table class="memberdecls">
  73. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  74. Data Fields</h2></td></tr>
  75. <tr class="memitem:a0a5e8e4e111450187e0760dc04a6f26e"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTAsync__connectData.html#a0a5e8e4e111450187e0760dc04a6f26e">struct_id</a> [4]</td></tr>
  76. <tr class="memdesc:a0a5e8e4e111450187e0760dc04a6f26e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The eyecatcher for this structure. <a href="structMQTTAsync__connectData.html#a0a5e8e4e111450187e0760dc04a6f26e">More...</a><br /></td></tr>
  77. <tr class="separator:a0a5e8e4e111450187e0760dc04a6f26e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:afb621feeaf54da918d9c5cfd084a1656"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTAsync__connectData.html#afb621feeaf54da918d9c5cfd084a1656">struct_version</a></td></tr>
  79. <tr class="memdesc:afb621feeaf54da918d9c5cfd084a1656"><td class="mdescLeft">&#160;</td><td class="mdescRight">The version number of this structure. <a href="structMQTTAsync__connectData.html#afb621feeaf54da918d9c5cfd084a1656">More...</a><br /></td></tr>
  80. <tr class="separator:afb621feeaf54da918d9c5cfd084a1656"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:ac239ae2f64049458d1b7ae6110c86657"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTAsync__connectData.html#ac239ae2f64049458d1b7ae6110c86657">username</a></td></tr>
  82. <tr class="memdesc:ac239ae2f64049458d1b7ae6110c86657"><td class="mdescLeft">&#160;</td><td class="mdescRight">MQTT servers that support the MQTT v3.1 protocol provide authentication and authorisation by user name and password. <a href="structMQTTAsync__connectData.html#ac239ae2f64049458d1b7ae6110c86657">More...</a><br /></td></tr>
  83. <tr class="separator:ac239ae2f64049458d1b7ae6110c86657"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a8643b5dacde868343c91cf6ad68d56b8"><td class="memItemLeft" >struct {</td></tr>
  85. <tr class="memitem:a16ef86e0072b799b3615090cd185b18d"><td class="memItemLeft" >
  86. &#160;&#160;&#160;int&#160;&#160;&#160;<a class="el" href="structMQTTAsync__connectData.html#a34da6971227839d7ae96394a8bb2c31c">len</a></td></tr>
  87. <tr class="memdesc:a16ef86e0072b799b3615090cd185b18d"><td class="mdescLeft">&#160;</td><td class="mdescRight">binary password length <br /></td></tr>
  88. <tr class="separator:a16ef86e0072b799b3615090cd185b18d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a9d7489dcae1d26925218ab0bfe82bd70"><td class="memItemLeft" >
  90. &#160;&#160;&#160;const void *&#160;&#160;&#160;<a class="el" href="structMQTTAsync__connectData.html#a3a5188d10f6aab79d85d0468a56e5033">data</a></td></tr>
  91. <tr class="memdesc:a9d7489dcae1d26925218ab0bfe82bd70"><td class="mdescLeft">&#160;</td><td class="mdescRight">binary password data <br /></td></tr>
  92. <tr class="separator:a9d7489dcae1d26925218ab0bfe82bd70"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a8643b5dacde868343c91cf6ad68d56b8"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTAsync__connectData.html#a8643b5dacde868343c91cf6ad68d56b8">binarypwd</a></td></tr>
  94. <tr class="memdesc:a8643b5dacde868343c91cf6ad68d56b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">The password parameter of the MQTT authentication. <a href="structMQTTAsync__connectData.html#a8643b5dacde868343c91cf6ad68d56b8">More...</a><br /></td></tr>
  95. <tr class="separator:a8643b5dacde868343c91cf6ad68d56b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. </table>
  97. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  98. <div class="textblock"><p>The connect options that can be updated before an automatic reconnect. </p>
  99. </div><h2 class="groupheader">Field Documentation</h2>
  100. <a id="a8643b5dacde868343c91cf6ad68d56b8"></a>
  101. <h2 class="memtitle"><span class="permalink"><a href="#a8643b5dacde868343c91cf6ad68d56b8">&#9670;&nbsp;</a></span>binarypwd</h2>
  102. <div class="memitem">
  103. <div class="memproto">
  104. <table class="memname">
  105. <tr>
  106. <td class="memname">struct { ... } MQTTAsync_connectData::binarypwd</td>
  107. </tr>
  108. </table>
  109. </div><div class="memdoc">
  110. <p>The password parameter of the MQTT authentication. </p>
  111. <p>Set data to NULL to remove. To change, allocate new storage with ::MQTTAsync_allocate - this will then be free later by the library. </p>
  112. </div>
  113. </div>
  114. <a id="a0a5e8e4e111450187e0760dc04a6f26e"></a>
  115. <h2 class="memtitle"><span class="permalink"><a href="#a0a5e8e4e111450187e0760dc04a6f26e">&#9670;&nbsp;</a></span>struct_id</h2>
  116. <div class="memitem">
  117. <div class="memproto">
  118. <table class="memname">
  119. <tr>
  120. <td class="memname">char MQTTAsync_connectData::struct_id[4]</td>
  121. </tr>
  122. </table>
  123. </div><div class="memdoc">
  124. <p>The eyecatcher for this structure. </p>
  125. <p>Will be MQCD. </p>
  126. </div>
  127. </div>
  128. <a id="afb621feeaf54da918d9c5cfd084a1656"></a>
  129. <h2 class="memtitle"><span class="permalink"><a href="#afb621feeaf54da918d9c5cfd084a1656">&#9670;&nbsp;</a></span>struct_version</h2>
  130. <div class="memitem">
  131. <div class="memproto">
  132. <table class="memname">
  133. <tr>
  134. <td class="memname">int MQTTAsync_connectData::struct_version</td>
  135. </tr>
  136. </table>
  137. </div><div class="memdoc">
  138. <p>The version number of this structure. </p>
  139. <p>Will be 0 </p>
  140. </div>
  141. </div>
  142. <a id="ac239ae2f64049458d1b7ae6110c86657"></a>
  143. <h2 class="memtitle"><span class="permalink"><a href="#ac239ae2f64049458d1b7ae6110c86657">&#9670;&nbsp;</a></span>username</h2>
  144. <div class="memitem">
  145. <div class="memproto">
  146. <table class="memname">
  147. <tr>
  148. <td class="memname">const char* MQTTAsync_connectData::username</td>
  149. </tr>
  150. </table>
  151. </div><div class="memdoc">
  152. <p>MQTT servers that support the MQTT v3.1 protocol provide authentication and authorisation by user name and password. </p>
  153. <p>This is the user name parameter. Set data to NULL to remove. To change, allocate new storage with ::MQTTAsync_allocate - this will then be free later by the library. </p>
  154. </div>
  155. </div>
  156. <hr/>The documentation for this struct was generated from the following file:<ul>
  157. <li>MQTTAsync.h</li>
  158. </ul>
  159. </div><!-- contents -->
  160. <!-- start footer part -->
  161. <hr class="footer"/><address class="footer"><small>
  162. 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">
  163. <img class="footer" src="doxygen.png" alt="doxygen"/>
  164. </a> 1.8.17
  165. </small></address>
  166. </body>
  167. </html>