mirror of
https://github.com/FreeRTOS/coreMQTT
synced 2025-05-12 13:24:58 +08:00
229 lines
13 KiB
HTML
229 lines
13 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.6"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>coreMQTT: Data Fields</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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.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>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function() { init_search(); });
|
|
/* @license-end */
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="style.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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">coreMQTT<span id="projectnumber"> v2.3.1</span>
|
|
</div>
|
|
<div id="projectbrief">MQTT 3.1.1 Client Library</div>
|
|
</td>
|
|
<td> <div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
|
|
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.6 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('functions.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="contents">
|
|
<div class="textblock">Here is a list of all documented struct and union fields with links to the struct/union documentation for each field:</div>
|
|
|
|
<h3><a id="index_a" name="index_a"></a>- a -</h3><ul>
|
|
<li>appCallback : <a class="el" href="struct_m_q_t_t_context__t.html#a73bd9259db9c3a9b84518cbf928ed91f">MQTTContext_t</a></li>
|
|
</ul>
|
|
|
|
|
|
<h3><a id="index_c" name="index_c"></a>- c -</h3><ul>
|
|
<li>cleanSession : <a class="el" href="struct_m_q_t_t_connect_info__t.html#a606e7765c4f2215fb2bf630f6eb9ff6b">MQTTConnectInfo_t</a></li>
|
|
<li>clientIdentifierLength : <a class="el" href="struct_m_q_t_t_connect_info__t.html#a8077ef36ab318f3d35bee6f098fa54d4">MQTTConnectInfo_t</a></li>
|
|
<li>connectStatus : <a class="el" href="struct_m_q_t_t_context__t.html#a4e38c4dc77e7751a0ad8730a41bee47f">MQTTContext_t</a></li>
|
|
<li>controlPacketSent : <a class="el" href="struct_m_q_t_t_context__t.html#af9724f2426132e3ce96a03892902ef89">MQTTContext_t</a></li>
|
|
</ul>
|
|
|
|
|
|
<h3><a id="index_d" name="index_d"></a>- d -</h3><ul>
|
|
<li>deserializationResult : <a class="el" href="struct_m_q_t_t_deserialized_info__t.html#a7df1b7b60404c9f1604fec0081d2625d">MQTTDeserializedInfo_t</a></li>
|
|
<li>dup : <a class="el" href="struct_m_q_t_t_publish_info__t.html#aa1c8954e83bfa678d1ff5429679d4e89">MQTTPublishInfo_t</a></li>
|
|
</ul>
|
|
|
|
|
|
<h3><a id="index_g" name="index_g"></a>- g -</h3><ul>
|
|
<li>getTime : <a class="el" href="struct_m_q_t_t_context__t.html#aabe1d302a16771292151013e8e30c582">MQTTContext_t</a></li>
|
|
</ul>
|
|
|
|
|
|
<h3><a id="index_h" name="index_h"></a>- h -</h3><ul>
|
|
<li>headerLength : <a class="el" href="struct_m_q_t_t_packet_info__t.html#aa7de1631ed8e08410942d36a72db558a">MQTTPacketInfo_t</a></li>
|
|
</ul>
|
|
|
|
|
|
<h3><a id="index_i" name="index_i"></a>- i -</h3><ul>
|
|
<li>incomingPublishRecordMaxCount : <a class="el" href="struct_m_q_t_t_context__t.html#aa33ed2e10380a854629f1386d0323ea8">MQTTContext_t</a></li>
|
|
<li>incomingPublishRecords : <a class="el" href="struct_m_q_t_t_context__t.html#afc147663a5933de81212fa77057f0a4d">MQTTContext_t</a></li>
|
|
<li>index : <a class="el" href="struct_m_q_t_t_context__t.html#a41b7735cd0746563483b72e17cf103aa">MQTTContext_t</a></li>
|
|
<li>iov_base : <a class="el" href="struct_transport_out_vector__t.html#a0ffa5c06bf00006cbafa8e244951038d">TransportOutVector_t</a></li>
|
|
<li>iov_len : <a class="el" href="struct_transport_out_vector__t.html#ada73dafb2d34311f33fefad38603b35c">TransportOutVector_t</a></li>
|
|
</ul>
|
|
|
|
|
|
<h3><a id="index_k" name="index_k"></a>- k -</h3><ul>
|
|
<li>keepAliveIntervalSec : <a class="el" href="struct_m_q_t_t_context__t.html#afd6071827ef48b230212a5725c2075be">MQTTContext_t</a></li>
|
|
<li>keepAliveSeconds : <a class="el" href="struct_m_q_t_t_connect_info__t.html#a7d05d53261732ebdfbb9ee665a347591">MQTTConnectInfo_t</a></li>
|
|
</ul>
|
|
|
|
|
|
<h3><a id="index_l" name="index_l"></a>- l -</h3><ul>
|
|
<li>lastPacketRxTime : <a class="el" href="struct_m_q_t_t_context__t.html#a7111ef16e4a4e75a72861f6f3ea8a7c3">MQTTContext_t</a></li>
|
|
<li>lastPacketTxTime : <a class="el" href="struct_m_q_t_t_context__t.html#a01acf90953e830ba3e7f44182cb1d482">MQTTContext_t</a></li>
|
|
</ul>
|
|
|
|
|
|
<h3><a id="index_n" name="index_n"></a>- n -</h3><ul>
|
|
<li>networkBuffer : <a class="el" href="struct_m_q_t_t_context__t.html#a231c5576a6ce389317a3f00f95628276">MQTTContext_t</a></li>
|
|
<li>nextPacketId : <a class="el" href="struct_m_q_t_t_context__t.html#af47ed55ad7e9bb112324f5f209b70534">MQTTContext_t</a></li>
|
|
</ul>
|
|
|
|
|
|
<h3><a id="index_o" name="index_o"></a>- o -</h3><ul>
|
|
<li>outgoingPublishRecordMaxCount : <a class="el" href="struct_m_q_t_t_context__t.html#a2851073e252d1e744596272ef13dd14a">MQTTContext_t</a></li>
|
|
<li>outgoingPublishRecords : <a class="el" href="struct_m_q_t_t_context__t.html#a4ea1e37e0e81f010fbf84365ac2ef6de">MQTTContext_t</a></li>
|
|
</ul>
|
|
|
|
|
|
<h3><a id="index_p" name="index_p"></a>- p -</h3><ul>
|
|
<li>packetId : <a class="el" href="struct_m_q_t_t_pub_ack_info__t.html#a66cef7b43af5d7fdd33b5d2dc766b2d0">MQTTPubAckInfo_t</a></li>
|
|
<li>packetIdentifier : <a class="el" href="struct_m_q_t_t_deserialized_info__t.html#af4df2a9926a4a68059195daa712d9b84">MQTTDeserializedInfo_t</a></li>
|
|
<li>passwordLength : <a class="el" href="struct_m_q_t_t_connect_info__t.html#a818c4e212a12020a4109eb890ec96383">MQTTConnectInfo_t</a></li>
|
|
<li>payloadLength : <a class="el" href="struct_m_q_t_t_publish_info__t.html#a7997964e11571f35f0c3b729db0f760f">MQTTPublishInfo_t</a></li>
|
|
<li>pBuffer : <a class="el" href="struct_m_q_t_t_fixed_buffer__t.html#acea147448e044870fb36b7fa2347dbd6">MQTTFixedBuffer_t</a></li>
|
|
<li>pClientIdentifier : <a class="el" href="struct_m_q_t_t_connect_info__t.html#a010f8f6993cbf8899648d5c515ff7884">MQTTConnectInfo_t</a></li>
|
|
<li>pingReqSendTimeMs : <a class="el" href="struct_m_q_t_t_context__t.html#acca3efa4146d85f7e874c7c326e23556">MQTTContext_t</a></li>
|
|
<li>pNetworkContext : <a class="el" href="struct_transport_interface__t.html#aaf4702050bef8d62714a4d3900e95087">TransportInterface_t</a></li>
|
|
<li>pPassword : <a class="el" href="struct_m_q_t_t_connect_info__t.html#acec6c79a11d2f0f130802393f34d2b5e">MQTTConnectInfo_t</a></li>
|
|
<li>pPayload : <a class="el" href="struct_m_q_t_t_publish_info__t.html#afc28299f4f625f5e674bb61b42f03380">MQTTPublishInfo_t</a></li>
|
|
<li>pPublishInfo : <a class="el" href="struct_m_q_t_t_deserialized_info__t.html#ac347273fae1e92b9cbeda1714066c1de">MQTTDeserializedInfo_t</a></li>
|
|
<li>pRemainingData : <a class="el" href="struct_m_q_t_t_packet_info__t.html#ac66cedff052bc844ec9b296387df60bc">MQTTPacketInfo_t</a></li>
|
|
<li>pTopicFilter : <a class="el" href="struct_m_q_t_t_subscribe_info__t.html#adb0b28240fdcd82a85f11cf2f8b5bbf0">MQTTSubscribeInfo_t</a></li>
|
|
<li>pTopicName : <a class="el" href="struct_m_q_t_t_publish_info__t.html#aa80e8ca282d01630f878ad0afe81d7a4">MQTTPublishInfo_t</a></li>
|
|
<li>publishState : <a class="el" href="struct_m_q_t_t_pub_ack_info__t.html#a61314203ef87a231c6489c68b579de34">MQTTPubAckInfo_t</a></li>
|
|
<li>pUserName : <a class="el" href="struct_m_q_t_t_connect_info__t.html#a1118d7d3251a11445318557280db53b4">MQTTConnectInfo_t</a></li>
|
|
</ul>
|
|
|
|
|
|
<h3><a id="index_q" name="index_q"></a>- q -</h3><ul>
|
|
<li>qos : <a class="el" href="struct_m_q_t_t_pub_ack_info__t.html#a086fcd48ef0b787697526a95c861e8a0">MQTTPubAckInfo_t</a>, <a class="el" href="struct_m_q_t_t_publish_info__t.html#a178224d02b4acdec7e08e88de0e4b399">MQTTPublishInfo_t</a>, <a class="el" href="struct_m_q_t_t_subscribe_info__t.html#a64cf2e423f60cfec122eeaef80c0fd86">MQTTSubscribeInfo_t</a></li>
|
|
</ul>
|
|
|
|
|
|
<h3><a id="index_r" name="index_r"></a>- r -</h3><ul>
|
|
<li>recv : <a class="el" href="struct_transport_interface__t.html#a7c34e9b865e2a509306f09c7dfa3699e">TransportInterface_t</a></li>
|
|
<li>remainingLength : <a class="el" href="struct_m_q_t_t_packet_info__t.html#a7c85becf08de0ec9776dd4be1fcc4bf8">MQTTPacketInfo_t</a></li>
|
|
<li>retain : <a class="el" href="struct_m_q_t_t_publish_info__t.html#a343b0af89c46a900db4aa5c775a0975a">MQTTPublishInfo_t</a></li>
|
|
</ul>
|
|
|
|
|
|
<h3><a id="index_s" name="index_s"></a>- s -</h3><ul>
|
|
<li>send : <a class="el" href="struct_transport_interface__t.html#a01cd9935e9a5266ca196243a0054d489">TransportInterface_t</a></li>
|
|
<li>size : <a class="el" href="struct_m_q_t_t_fixed_buffer__t.html#a0b0b6a93cc62751ebeb03095d5431636">MQTTFixedBuffer_t</a></li>
|
|
</ul>
|
|
|
|
|
|
<h3><a id="index_t" name="index_t"></a>- t -</h3><ul>
|
|
<li>topicFilterLength : <a class="el" href="struct_m_q_t_t_subscribe_info__t.html#a6972f8e036f8bde9b1f23a2aacb61382">MQTTSubscribeInfo_t</a></li>
|
|
<li>topicNameLength : <a class="el" href="struct_m_q_t_t_publish_info__t.html#a6161c792d20cc7cf8284c1b71ea1145f">MQTTPublishInfo_t</a></li>
|
|
<li>transportInterface : <a class="el" href="struct_m_q_t_t_context__t.html#a87ab9d61e7711325c2c85ce3ce63386a">MQTTContext_t</a></li>
|
|
<li>type : <a class="el" href="struct_m_q_t_t_packet_info__t.html#a7fef40548c1aa0f0e7f812a6a7243758">MQTTPacketInfo_t</a></li>
|
|
</ul>
|
|
|
|
|
|
<h3><a id="index_u" name="index_u"></a>- u -</h3><ul>
|
|
<li>userNameLength : <a class="el" href="struct_m_q_t_t_connect_info__t.html#a7165be3bb06d4527ab4eb773b50e05e1">MQTTConnectInfo_t</a></li>
|
|
</ul>
|
|
|
|
|
|
<h3><a id="index_w" name="index_w"></a>- w -</h3><ul>
|
|
<li>waitingForPingResp : <a class="el" href="struct_m_q_t_t_context__t.html#ac7073f43645f7b7c0c5b7763980004bb">MQTTContext_t</a></li>
|
|
<li>writev : <a class="el" href="struct_transport_interface__t.html#a8cf677fbeee53d270daa6dacfa138b79">TransportInterface_t</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|