structMQTTAsync__failureData5.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185
  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_failureData5 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_failureData5 Struct Reference</div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p>The data returned on completion of an unsuccessful API call in the response callback onFailure.
  70. <a href="structMQTTAsync__failureData5.html#details">More...</a></p>
  71. <p><code>#include &lt;MQTTAsync.h&gt;</code></p>
  72. <div class="dynheader">
  73. Collaboration diagram for MQTTAsync_failureData5:</div>
  74. <div class="dyncontent">
  75. <div class="center"><img src="structMQTTAsync__failureData5__coll__graph.png" border="0" usemap="#MQTTAsync__failureData5_coll__map" alt="Collaboration graph"/></div>
  76. <map name="MQTTAsync__failureData5_coll__map" id="MQTTAsync__failureData5_coll__map">
  77. <area shape="rect" title="The data returned on completion of an unsuccessful API call in the response callback onFailure." alt="" coords="5,288,176,315"/>
  78. <area shape="rect" href="structMQTTProperties.html" title="MQTT version 5 property list." alt="" coords="31,199,150,225"/>
  79. <area shape="rect" href="structMQTTProperty.html" title="Structure to hold an MQTT version 5 property of any type." alt="" coords="37,109,144,136"/>
  80. <area shape="rect" href="structMQTTLenString.html" title="The data for a length delimited string." alt="" coords="33,5,148,32"/>
  81. </map>
  82. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  83. <table class="memberdecls">
  84. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  85. Data Fields</h2></td></tr>
  86. <tr class="memitem:ab1408c66810d6761ec8b77190581f3bb"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTAsync__failureData5.html#ab1408c66810d6761ec8b77190581f3bb">struct_id</a> [4]</td></tr>
  87. <tr class="memdesc:ab1408c66810d6761ec8b77190581f3bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">The eyecatcher for this structure. <a href="structMQTTAsync__failureData5.html#ab1408c66810d6761ec8b77190581f3bb">More...</a><br /></td></tr>
  88. <tr class="separator:ab1408c66810d6761ec8b77190581f3bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:afc4100c8f3126342b75e60dcd720836f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTAsync__failureData5.html#afc4100c8f3126342b75e60dcd720836f">struct_version</a></td></tr>
  90. <tr class="memdesc:afc4100c8f3126342b75e60dcd720836f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The version number of this structure. <a href="structMQTTAsync__failureData5.html#afc4100c8f3126342b75e60dcd720836f">More...</a><br /></td></tr>
  91. <tr class="separator:afc4100c8f3126342b75e60dcd720836f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:af3be141ec32e131429a1ea9df6386eb5"><td class="memItemLeft" align="right" valign="top"><a id="af3be141ec32e131429a1ea9df6386eb5"></a>
  93. MQTTAsync_token&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTAsync__failureData5.html#af3be141ec32e131429a1ea9df6386eb5">token</a></td></tr>
  94. <tr class="memdesc:af3be141ec32e131429a1ea9df6386eb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">A token identifying the failed request. <br /></td></tr>
  95. <tr class="separator:af3be141ec32e131429a1ea9df6386eb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a42afb6bf2c55f9830dc1d0984b251019"><td class="memItemLeft" align="right" valign="top"><a id="a42afb6bf2c55f9830dc1d0984b251019"></a>
  97. enum MQTTReasonCodes&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTAsync__failureData5.html#a42afb6bf2c55f9830dc1d0984b251019">reasonCode</a></td></tr>
  98. <tr class="memdesc:a42afb6bf2c55f9830dc1d0984b251019"><td class="mdescLeft">&#160;</td><td class="mdescRight">The MQTT reason code returned. <br /></td></tr>
  99. <tr class="separator:a42afb6bf2c55f9830dc1d0984b251019"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a9c1807e86e398de6f4846d90b4a5eda6"><td class="memItemLeft" align="right" valign="top"><a id="a9c1807e86e398de6f4846d90b4a5eda6"></a>
  101. <a class="el" href="structMQTTProperties.html">MQTTProperties</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTAsync__failureData5.html#a9c1807e86e398de6f4846d90b4a5eda6">properties</a></td></tr>
  102. <tr class="memdesc:a9c1807e86e398de6f4846d90b4a5eda6"><td class="mdescLeft">&#160;</td><td class="mdescRight">The MQTT properties on the ack, if any. <br /></td></tr>
  103. <tr class="separator:a9c1807e86e398de6f4846d90b4a5eda6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:ac92de089ce2d9ae81b2c4b0dc1f97792"><td class="memItemLeft" align="right" valign="top"><a id="ac92de089ce2d9ae81b2c4b0dc1f97792"></a>
  105. int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTAsync__failureData5.html#ac92de089ce2d9ae81b2c4b0dc1f97792">code</a></td></tr>
  106. <tr class="memdesc:ac92de089ce2d9ae81b2c4b0dc1f97792"><td class="mdescLeft">&#160;</td><td class="mdescRight">A numeric code identifying the MQTT client library error. <br /></td></tr>
  107. <tr class="separator:ac92de089ce2d9ae81b2c4b0dc1f97792"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a2f82528951018af0eb73b313b94a470e"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTAsync__failureData5.html#a2f82528951018af0eb73b313b94a470e">message</a></td></tr>
  109. <tr class="memdesc:a2f82528951018af0eb73b313b94a470e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optional further text explaining the error. <a href="structMQTTAsync__failureData5.html#a2f82528951018af0eb73b313b94a470e">More...</a><br /></td></tr>
  110. <tr class="separator:a2f82528951018af0eb73b313b94a470e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a20603650f6fd4e429fc4c246d5005843"><td class="memItemLeft" align="right" valign="top"><a id="a20603650f6fd4e429fc4c246d5005843"></a>
  112. int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTAsync__failureData5.html#a20603650f6fd4e429fc4c246d5005843">packet_type</a></td></tr>
  113. <tr class="memdesc:a20603650f6fd4e429fc4c246d5005843"><td class="mdescLeft">&#160;</td><td class="mdescRight">Packet type on which the failure occurred - used for publish QoS 1/2 exchanges. <br /></td></tr>
  114. <tr class="separator:a20603650f6fd4e429fc4c246d5005843"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. </table>
  116. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  117. <div class="textblock"><p>The data returned on completion of an unsuccessful API call in the response callback onFailure. </p>
  118. </div><h2 class="groupheader">Field Documentation</h2>
  119. <a id="a2f82528951018af0eb73b313b94a470e"></a>
  120. <h2 class="memtitle"><span class="permalink"><a href="#a2f82528951018af0eb73b313b94a470e">&#9670;&nbsp;</a></span>message</h2>
  121. <div class="memitem">
  122. <div class="memproto">
  123. <table class="memname">
  124. <tr>
  125. <td class="memname">const char* MQTTAsync_failureData5::message</td>
  126. </tr>
  127. </table>
  128. </div><div class="memdoc">
  129. <p>Optional further text explaining the error. </p>
  130. <p>Can be NULL. </p>
  131. </div>
  132. </div>
  133. <a id="ab1408c66810d6761ec8b77190581f3bb"></a>
  134. <h2 class="memtitle"><span class="permalink"><a href="#ab1408c66810d6761ec8b77190581f3bb">&#9670;&nbsp;</a></span>struct_id</h2>
  135. <div class="memitem">
  136. <div class="memproto">
  137. <table class="memname">
  138. <tr>
  139. <td class="memname">char MQTTAsync_failureData5::struct_id[4]</td>
  140. </tr>
  141. </table>
  142. </div><div class="memdoc">
  143. <p>The eyecatcher for this structure. </p>
  144. <p>Will be MQFD. </p>
  145. </div>
  146. </div>
  147. <a id="afc4100c8f3126342b75e60dcd720836f"></a>
  148. <h2 class="memtitle"><span class="permalink"><a href="#afc4100c8f3126342b75e60dcd720836f">&#9670;&nbsp;</a></span>struct_version</h2>
  149. <div class="memitem">
  150. <div class="memproto">
  151. <table class="memname">
  152. <tr>
  153. <td class="memname">int MQTTAsync_failureData5::struct_version</td>
  154. </tr>
  155. </table>
  156. </div><div class="memdoc">
  157. <p>The version number of this structure. </p>
  158. <p>Will be 0 </p>
  159. </div>
  160. </div>
  161. <hr/>The documentation for this struct was generated from the following file:<ul>
  162. <li>MQTTAsync.h</li>
  163. </ul>
  164. </div><!-- contents -->
  165. <!-- start footer part -->
  166. <hr class="footer"/><address class="footer"><small>
  167. 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">
  168. <img class="footer" src="doxygen.png" alt="doxygen"/>
  169. </a> 1.8.17
  170. </small></address>
  171. </body>
  172. </html>