| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.14"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Paho Asynchronous MQTT C Client Library: MQTTAsync_failureData5 Struct Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectlogo"><img alt="Logo" src="pahologo.png"/></td> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Paho Asynchronous MQTT C Client Library |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.14 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-attribs">Data Fields</a> </div> |
| <div class="headertitle"> |
| <div class="title">MQTTAsync_failureData5 Struct Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><code>#include <<a class="el" href="_m_q_t_t_async_8h_source.html">MQTTAsync.h</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> |
| Data Fields</h2></td></tr> |
| <tr class="memitem:aa5326df180cb23c59afbcab711a06479"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_async__failure_data5.html#aa5326df180cb23c59afbcab711a06479">struct_id</a> [4]</td></tr> |
| <tr class="separator:aa5326df180cb23c59afbcab711a06479"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0761a5e5be0383882e42924de8e51f82"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_async__failure_data5.html#a0761a5e5be0383882e42924de8e51f82">struct_version</a></td></tr> |
| <tr class="separator:a0761a5e5be0383882e42924de8e51f82"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af8f771e67d284379111151b003c0d810"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_m_q_t_t_async_8h.html#a7ca6d2a1813f2bbd0bc3af2771e46ba4">MQTTAsync_token</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_async__failure_data5.html#af8f771e67d284379111151b003c0d810">token</a></td></tr> |
| <tr class="separator:af8f771e67d284379111151b003c0d810"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a580d8a8ecb285f5a86c2a3865438f8ee"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="_m_q_t_t_reason_codes_8h.html#aba6db0fccfa3f8972ea48117b8b2a279">MQTTReasonCodes</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_async__failure_data5.html#a580d8a8ecb285f5a86c2a3865438f8ee">reasonCode</a></td></tr> |
| <tr class="separator:a580d8a8ecb285f5a86c2a3865438f8ee"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1594008402f7307e4de8fa6131656dde"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_m_q_t_t_properties.html">MQTTProperties</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_async__failure_data5.html#a1594008402f7307e4de8fa6131656dde">properties</a></td></tr> |
| <tr class="separator:a1594008402f7307e4de8fa6131656dde"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a45a5b7c00a796a23f01673cef1dbe0a9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_async__failure_data5.html#a45a5b7c00a796a23f01673cef1dbe0a9">code</a></td></tr> |
| <tr class="separator:a45a5b7c00a796a23f01673cef1dbe0a9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a254bf0858da09c96a48daf64404eb4f8"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_async__failure_data5.html#a254bf0858da09c96a48daf64404eb4f8">message</a></td></tr> |
| <tr class="separator:a254bf0858da09c96a48daf64404eb4f8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a38dfee9f038f473c95af46fcef5dd3e9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_async__failure_data5.html#a38dfee9f038f473c95af46fcef5dd3e9">packet_type</a></td></tr> |
| <tr class="separator:a38dfee9f038f473c95af46fcef5dd3e9"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>The data returned on completion of an unsuccessful API call in the response callback onFailure. </p> |
| </div><h2 class="groupheader">Field Documentation</h2> |
| <a id="aa5326df180cb23c59afbcab711a06479"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa5326df180cb23c59afbcab711a06479">◆ </a></span>struct_id</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">char struct_id[4]</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>The eyecatcher for this structure. Will be MQFD. </p> |
| |
| </div> |
| </div> |
| <a id="a0761a5e5be0383882e42924de8e51f82"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0761a5e5be0383882e42924de8e51f82">◆ </a></span>struct_version</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int struct_version</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>The version number of this structure. Will be 0 </p> |
| |
| </div> |
| </div> |
| <a id="af8f771e67d284379111151b003c0d810"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af8f771e67d284379111151b003c0d810">◆ </a></span>token</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="_m_q_t_t_async_8h.html#a7ca6d2a1813f2bbd0bc3af2771e46ba4">MQTTAsync_token</a> token</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>A token identifying the failed request. </p> |
| |
| </div> |
| </div> |
| <a id="a580d8a8ecb285f5a86c2a3865438f8ee"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a580d8a8ecb285f5a86c2a3865438f8ee">◆ </a></span>reasonCode</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum <a class="el" href="_m_q_t_t_reason_codes_8h.html#aba6db0fccfa3f8972ea48117b8b2a279">MQTTReasonCodes</a> reasonCode</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>The MQTT reason code returned. </p> |
| |
| </div> |
| </div> |
| <a id="a1594008402f7307e4de8fa6131656dde"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1594008402f7307e4de8fa6131656dde">◆ </a></span>properties</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="struct_m_q_t_t_properties.html">MQTTProperties</a> properties</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>The MQTT properties on the ack, if any. </p> |
| |
| </div> |
| </div> |
| <a id="a45a5b7c00a796a23f01673cef1dbe0a9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a45a5b7c00a796a23f01673cef1dbe0a9">◆ </a></span>code</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int code</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>A numeric code identifying the MQTT client library error. </p> |
| |
| </div> |
| </div> |
| <a id="a254bf0858da09c96a48daf64404eb4f8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a254bf0858da09c96a48daf64404eb4f8">◆ </a></span>message</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const char* message</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Optional further text explaining the error. Can be NULL. </p> |
| |
| </div> |
| </div> |
| <a id="a38dfee9f038f473c95af46fcef5dd3e9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a38dfee9f038f473c95af46fcef5dd3e9">◆ </a></span>packet_type</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int packet_type</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Packet type on which the failure occurred - used for publish QoS 1/2 exchanges </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this struct was generated from the following file:<ul> |
| <li><a class="el" href="_m_q_t_t_async_8h_source.html">MQTTAsync.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Sep 13 2018 13:40:20 for Paho Asynchronous MQTT C Client Library by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.14 |
| </small></address> |
| </body> |
| </html> |