FreeRTOS/coreMQTT
1
0
Fork 0
mirror of https://github.com/FreeRTOS/coreMQTT synced 2025-05-14 22:30:21 +08:00
Code Issues Releases Wiki Activity
coreMQTT/v1.2.0/core__mqtt_8h_source.html
Archit Gupta b52869ae0f
Add old doxygen bundles to gh-pages (#185) 
* Add historical doxygen bundles

* Update gh-pages doxygen index page configuration
2021-12-22 11:13:30 -08:00

405 lines
80 KiB
HTML
Raw Permalink Blame History

<!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">
<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.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>coreMQTT: core_mqtt.h Source File</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&amp;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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">coreMQTT<span id="projectnumber">&#160;v1.2.0</span>
</div>
<div id="projectbrief">MQTT 3.1.1 Client Library</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="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.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('core__mqtt_8h_source.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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle"><div class="title">core_mqtt.h</div></div>
</div><!--header-->
<div class="contents">
<a href="core__mqtt_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * coreMQTT v1.2.0</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy of</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * this software and associated documentation files (the &quot;Software&quot;), to deal in</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * the Software without restriction, including without limitation the rights to</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * the Software, and to permit persons to whom the Software is furnished to do so,</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * subject to the following conditions:</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * The above copyright notice and this permission notice shall be included in all</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * copies or substantial portions of the Software.</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> *</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"> * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"> * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment"> */</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#ifndef CORE_MQTT_H</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#define CORE_MQTT_H</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment">/* *INDENT-OFF* */</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment">/* *INDENT-ON* */</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="comment">/* MQTT_DO_NOT_USE_CUSTOM_CONFIG allows building the MQTT library</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment"> * without a custom config. If a custom config is provided, the</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment"> * MQTT_DO_NOT_USE_CUSTOM_CONFIG macro should not be defined. */</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="preprocessor">#ifndef MQTT_DO_NOT_USE_CUSTOM_CONFIG</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="comment">/* Include custom config file before other headers. */</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="preprocessor"> #include &quot;core_mqtt_config.h&quot;</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="comment">/* Include config defaults header to get default values of configs not</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment"> * defined in core_mqtt_config.h file. */</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="preprocessor">#include &quot;<a class="code" href="core__mqtt__config__defaults_8h.html">core_mqtt_config_defaults.h</a>&quot;</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment">/* Include MQTT serializer library. */</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="preprocessor">#include &quot;<a class="code" href="core__mqtt__serializer_8h.html">core_mqtt_serializer.h</a>&quot;</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="comment">/* Include transport interface. */</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="preprocessor">#include &quot;<a class="code" href="transport__interface_8h.html">transport_interface.h</a>&quot;</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="preprocessor">#define MQTT_LIBRARY_VERSION &quot;v1.2.0&quot;</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="group__mqtt__constants.html#ga9fde6503edb9eaad50ecd3392ab9992a"> 67</a></span><span class="preprocessor">#define MQTT_PACKET_ID_INVALID ( ( uint16_t ) 0U )</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="comment">/* Structures defined in this file. */</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="keyword">struct </span>MQTTPubAckInfo;</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span><span class="keyword">struct </span>MQTTContext;</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="keyword">struct </span>MQTTDeserializedInfo;</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="group__mqtt__callback__types.html#gae3bea55b0e49e5208b8c5709a5ea23aa"> 81</a></span><span class="keyword">typedef</span> uint32_t (* <a class="code hl_typedef" href="group__mqtt__callback__types.html#gae3bea55b0e49e5208b8c5709a5ea23aa">MQTTGetCurrentTimeFunc_t</a> )( void );</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="group__mqtt__callback__types.html#ga00d348277ed4fde23c95bfc749ae954a"> 96</a></span><span class="keyword">typedef</span> void (* <a class="code hl_typedef" href="group__mqtt__callback__types.html#ga00d348277ed4fde23c95bfc749ae954a">MQTTEventCallback_t</a> )( <span class="keyword">struct </span>MQTTContext * pContext,</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="keyword">struct </span>MQTTPacketInfo * pPacketInfo,</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">struct </span>MQTTDeserializedInfo * pDeserializedInfo );</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#ga9f84d003695205cf10a7bd0bafb3dbf6"> 104</a></span><span class="keyword">typedef</span> <span class="keyword">enum</span> MQTTConnectionStatus</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span>{</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#gga9f84d003695205cf10a7bd0bafb3dbf6a0320177ebf1f1b2e24646b44702cec69"> 106</a></span> <a class="code hl_enumvalue" href="group__mqtt__enum__types.html#gga9f84d003695205cf10a7bd0bafb3dbf6a0320177ebf1f1b2e24646b44702cec69">MQTTNotConnected</a>, </div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> <a class="code hl_enumvalue" href="group__mqtt__enum__types.html#gga9f84d003695205cf10a7bd0bafb3dbf6a82c8f64d976734e5632e5257bc429ef5">MQTTConnected</a> </div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#gga9f84d003695205cf10a7bd0bafb3dbf6a82c8f64d976734e5632e5257bc429ef5"> 108</a></span>} <a class="code hl_enumeration" href="group__mqtt__enum__types.html#ga9f84d003695205cf10a7bd0bafb3dbf6">MQTTConnectionStatus_t</a>;</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> </div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#ga0480de7552eedd739a26a23fa8e6fd94"> 114</a></span><span class="keyword">typedef</span> <span class="keyword">enum</span> MQTTPublishState</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span>{</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a8349567b7a9efb3913a64a8f4f6fe5c9"> 116</a></span> <a class="code hl_enumvalue" href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a8349567b7a9efb3913a64a8f4f6fe5c9">MQTTStateNull</a> = 0, </div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a896b1507647b504c9208580e4cde26ad"> 117</a></span> <a class="code hl_enumvalue" href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a896b1507647b504c9208580e4cde26ad">MQTTPublishSend</a>, </div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a65f6f7b343a30fc0558e3aeeb8c97f35"> 118</a></span> <a class="code hl_enumvalue" href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a65f6f7b343a30fc0558e3aeeb8c97f35">MQTTPubAckSend</a>, </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a11e2319a2b25b82121471743d39761e1"> 119</a></span> <a class="code hl_enumvalue" href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a11e2319a2b25b82121471743d39761e1">MQTTPubRecSend</a>, </div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a5d2ee2709c6dc7a1eb8b9c40f318909b"> 120</a></span> <a class="code hl_enumvalue" href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a5d2ee2709c6dc7a1eb8b9c40f318909b">MQTTPubRelSend</a>, </div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a7d88904d550b502b4424a41aa4205e56"> 121</a></span> <a class="code hl_enumvalue" href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a7d88904d550b502b4424a41aa4205e56">MQTTPubCompSend</a>, </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94ab086c55acf106cdc8d420f90899b6803"> 122</a></span> <a class="code hl_enumvalue" href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94ab086c55acf106cdc8d420f90899b6803">MQTTPubAckPending</a>, </div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a1bea59454700be9b683b7eb8aaf6bb4f"> 123</a></span> <a class="code hl_enumvalue" href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a1bea59454700be9b683b7eb8aaf6bb4f">MQTTPubRecPending</a>, </div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a695431cde1dc9dc5a2dcbd10eba49df2"> 124</a></span> <a class="code hl_enumvalue" href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a695431cde1dc9dc5a2dcbd10eba49df2">MQTTPubRelPending</a>, </div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a3281a28d1829d954b596f091b547b627"> 125</a></span> <a class="code hl_enumvalue" href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a3281a28d1829d954b596f091b547b627">MQTTPubCompPending</a>, </div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> <a class="code hl_enumvalue" href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94ad07733793a235ef9a6a04d16637cd7dc">MQTTPublishDone</a> </div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94ad07733793a235ef9a6a04d16637cd7dc"> 127</a></span>} <a class="code hl_enumeration" href="group__mqtt__enum__types.html#ga0480de7552eedd739a26a23fa8e6fd94">MQTTPublishState_t</a>;</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> </div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#ga8c1bee959b3ed5fab2a2688dd72bf237"> 133</a></span><span class="keyword">typedef</span> <span class="keyword">enum</span> MQTTPubAckType</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span>{</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#gga8c1bee959b3ed5fab2a2688dd72bf237a53d5939c680962f37c15ee87ffd63d0f"> 135</a></span> <a class="code hl_enumvalue" href="group__mqtt__enum__types.html#gga8c1bee959b3ed5fab2a2688dd72bf237a53d5939c680962f37c15ee87ffd63d0f">MQTTPuback</a>, </div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#gga8c1bee959b3ed5fab2a2688dd72bf237a8c98d5d1a68dda33d9039009ab4ef053"> 136</a></span> <a class="code hl_enumvalue" href="group__mqtt__enum__types.html#gga8c1bee959b3ed5fab2a2688dd72bf237a8c98d5d1a68dda33d9039009ab4ef053">MQTTPubrec</a>, </div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#gga8c1bee959b3ed5fab2a2688dd72bf237af2d737088a231c88e7603acfdbc4fc8c"> 137</a></span> <a class="code hl_enumvalue" href="group__mqtt__enum__types.html#gga8c1bee959b3ed5fab2a2688dd72bf237af2d737088a231c88e7603acfdbc4fc8c">MQTTPubrel</a>, </div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> <a class="code hl_enumvalue" href="group__mqtt__enum__types.html#gga8c1bee959b3ed5fab2a2688dd72bf237a910c34311ad6a2341afc04839e1c13bd">MQTTPubcomp</a> </div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#gga8c1bee959b3ed5fab2a2688dd72bf237a910c34311ad6a2341afc04839e1c13bd"> 139</a></span>} <a class="code hl_enumeration" href="group__mqtt__enum__types.html#ga8c1bee959b3ed5fab2a2688dd72bf237">MQTTPubAckType_t</a>;</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> </div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#ga48dabc1579e3c0ac6058ce9068054611"> 145</a></span><span class="keyword">typedef</span> <span class="keyword">enum</span> MQTTSubAckStatus</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span>{</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#gga48dabc1579e3c0ac6058ce9068054611abcc3040d7d53025baee3542c40758abb"> 147</a></span> <a class="code hl_enumvalue" href="group__mqtt__enum__types.html#gga48dabc1579e3c0ac6058ce9068054611abcc3040d7d53025baee3542c40758abb">MQTTSubAckSuccessQos0</a> = 0x00, </div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#gga48dabc1579e3c0ac6058ce9068054611ab180361a6da712c8144d8c499537787d"> 148</a></span> <a class="code hl_enumvalue" href="group__mqtt__enum__types.html#gga48dabc1579e3c0ac6058ce9068054611ab180361a6da712c8144d8c499537787d">MQTTSubAckSuccessQos1</a> = 0x01, </div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#gga48dabc1579e3c0ac6058ce9068054611a877b2afbc6ec7d9ab57d4862caadf4f1"> 149</a></span> <a class="code hl_enumvalue" href="group__mqtt__enum__types.html#gga48dabc1579e3c0ac6058ce9068054611a877b2afbc6ec7d9ab57d4862caadf4f1">MQTTSubAckSuccessQos2</a> = 0x02, </div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> <a class="code hl_enumvalue" href="group__mqtt__enum__types.html#gga48dabc1579e3c0ac6058ce9068054611aeb83b20da8eda934cde6b92db225a808">MQTTSubAckFailure</a> = 0x80 </div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"><a class="line" href="group__mqtt__enum__types.html#gga48dabc1579e3c0ac6058ce9068054611aeb83b20da8eda934cde6b92db225a808"> 151</a></span>} <a class="code hl_enumeration" href="group__mqtt__enum__types.html#ga48dabc1579e3c0ac6058ce9068054611">MQTTSubAckStatus_t</a>;</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> </div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"><a class="line" href="struct_m_q_t_t_pub_ack_info__t.html"> 157</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span>MQTTPubAckInfo</div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span>{</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"><a class="line" href="struct_m_q_t_t_pub_ack_info__t.html#a66cef7b43af5d7fdd33b5d2dc766b2d0"> 159</a></span> uint16_t <a class="code hl_variable" href="struct_m_q_t_t_pub_ack_info__t.html#a66cef7b43af5d7fdd33b5d2dc766b2d0">packetId</a>; </div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"><a class="line" href="struct_m_q_t_t_pub_ack_info__t.html#a086fcd48ef0b787697526a95c861e8a0"> 160</a></span> <a class="code hl_enumeration" href="group__mqtt__enum__types.html#gae308a5928d7f537379c29a894228093a">MQTTQoS_t</a> <a class="code hl_variable" href="struct_m_q_t_t_pub_ack_info__t.html#a086fcd48ef0b787697526a95c861e8a0">qos</a>; </div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"><a class="line" href="struct_m_q_t_t_pub_ack_info__t.html#a61314203ef87a231c6489c68b579de34"> 161</a></span> <a class="code hl_enumeration" href="group__mqtt__enum__types.html#ga0480de7552eedd739a26a23fa8e6fd94">MQTTPublishState_t</a> <a class="code hl_variable" href="struct_m_q_t_t_pub_ack_info__t.html#a61314203ef87a231c6489c68b579de34">publishState</a>; </div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span>} <a class="code hl_struct" href="struct_m_q_t_t_pub_ack_info__t.html">MQTTPubAckInfo_t</a>;</div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span> </div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"><a class="line" href="struct_m_q_t_t_context__t.html"> 168</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span>MQTTContext</div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span>{</div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"><a class="line" href="struct_m_q_t_t_context__t.html#ad2845a6789e2f49dae22d67c91e48d53"> 173</a></span> <a class="code hl_struct" href="struct_m_q_t_t_pub_ack_info__t.html">MQTTPubAckInfo_t</a> outgoingPublishRecords[ <a class="code hl_define" href="core__mqtt__config__defaults_8h.html#a50b149716607c0b7974c391830f1b007">MQTT_STATE_ARRAY_MAX_COUNT</a> ];</div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno"> 174</span> </div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"><a class="line" href="struct_m_q_t_t_context__t.html#a2603a6d9ba3443a323f2262025b5c5ef"> 178</a></span> <a class="code hl_struct" href="struct_m_q_t_t_pub_ack_info__t.html">MQTTPubAckInfo_t</a> incomingPublishRecords[ <a class="code hl_define" href="core__mqtt__config__defaults_8h.html#a50b149716607c0b7974c391830f1b007">MQTT_STATE_ARRAY_MAX_COUNT</a> ];</div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span> </div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno"><a class="line" href="struct_m_q_t_t_context__t.html#a87ab9d61e7711325c2c85ce3ce63386a"> 183</a></span> <a class="code hl_struct" href="struct_transport_interface__t.html">TransportInterface_t</a> <a class="code hl_variable" href="struct_m_q_t_t_context__t.html#a87ab9d61e7711325c2c85ce3ce63386a">transportInterface</a>;</div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> </div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"><a class="line" href="struct_m_q_t_t_context__t.html#a231c5576a6ce389317a3f00f95628276"> 188</a></span> <a class="code hl_struct" href="struct_m_q_t_t_fixed_buffer__t.html">MQTTFixedBuffer_t</a> <a class="code hl_variable" href="struct_m_q_t_t_context__t.html#a231c5576a6ce389317a3f00f95628276">networkBuffer</a>;</div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span> </div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno"><a class="line" href="struct_m_q_t_t_context__t.html#af47ed55ad7e9bb112324f5f209b70534"> 193</a></span> uint16_t <a class="code hl_variable" href="struct_m_q_t_t_context__t.html#af47ed55ad7e9bb112324f5f209b70534">nextPacketId</a>;</div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span> </div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno"><a class="line" href="struct_m_q_t_t_context__t.html#a4e38c4dc77e7751a0ad8730a41bee47f"> 198</a></span> <a class="code hl_enumeration" href="group__mqtt__enum__types.html#ga9f84d003695205cf10a7bd0bafb3dbf6">MQTTConnectionStatus_t</a> <a class="code hl_variable" href="struct_m_q_t_t_context__t.html#a4e38c4dc77e7751a0ad8730a41bee47f">connectStatus</a>;</div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span> </div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno"><a class="line" href="struct_m_q_t_t_context__t.html#aabe1d302a16771292151013e8e30c582"> 203</a></span> <a class="code hl_typedef" href="group__mqtt__callback__types.html#gae3bea55b0e49e5208b8c5709a5ea23aa">MQTTGetCurrentTimeFunc_t</a> <a class="code hl_variable" href="struct_m_q_t_t_context__t.html#aabe1d302a16771292151013e8e30c582">getTime</a>;</div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno"> 204</span> </div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno"><a class="line" href="struct_m_q_t_t_context__t.html#a73bd9259db9c3a9b84518cbf928ed91f"> 208</a></span> <a class="code hl_typedef" href="group__mqtt__callback__types.html#ga00d348277ed4fde23c95bfc749ae954a">MQTTEventCallback_t</a> <a class="code hl_variable" href="struct_m_q_t_t_context__t.html#a73bd9259db9c3a9b84518cbf928ed91f">appCallback</a>;</div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno"> 209</span> </div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno"><a class="line" href="struct_m_q_t_t_context__t.html#abd7afb708927ec69530408defa192d2f"> 213</a></span> uint32_t <a class="code hl_variable" href="struct_m_q_t_t_context__t.html#abd7afb708927ec69530408defa192d2f">lastPacketTime</a>;</div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno"> 214</span> </div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"><a class="line" href="struct_m_q_t_t_context__t.html#af9724f2426132e3ce96a03892902ef89"> 219</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="struct_m_q_t_t_context__t.html#af9724f2426132e3ce96a03892902ef89">controlPacketSent</a>;</div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno"> 220</span> </div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span> <span class="comment">/* Keep alive members. */</span></div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"><a class="line" href="struct_m_q_t_t_context__t.html#afd6071827ef48b230212a5725c2075be"> 222</a></span> uint16_t <a class="code hl_variable" href="struct_m_q_t_t_context__t.html#afd6071827ef48b230212a5725c2075be">keepAliveIntervalSec</a>; </div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"><a class="line" href="struct_m_q_t_t_context__t.html#acca3efa4146d85f7e874c7c326e23556"> 223</a></span> uint32_t <a class="code hl_variable" href="struct_m_q_t_t_context__t.html#acca3efa4146d85f7e874c7c326e23556">pingReqSendTimeMs</a>; </div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"><a class="line" href="struct_m_q_t_t_context__t.html#ac7073f43645f7b7c0c5b7763980004bb"> 224</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="struct_m_q_t_t_context__t.html#ac7073f43645f7b7c0c5b7763980004bb">waitingForPingResp</a>; </div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno"> 225</span>} <a class="code hl_struct" href="struct_m_q_t_t_context__t.html">MQTTContext_t</a>;</div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"> 226</span> </div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno"><a class="line" href="struct_m_q_t_t_deserialized_info__t.html"> 232</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span>MQTTDeserializedInfo</div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno"> 233</span>{</div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno"><a class="line" href="struct_m_q_t_t_deserialized_info__t.html#af4df2a9926a4a68059195daa712d9b84"> 234</a></span> uint16_t <a class="code hl_variable" href="struct_m_q_t_t_deserialized_info__t.html#af4df2a9926a4a68059195daa712d9b84">packetIdentifier</a>; </div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno"><a class="line" href="struct_m_q_t_t_deserialized_info__t.html#ac347273fae1e92b9cbeda1714066c1de"> 235</a></span> <a class="code hl_struct" href="struct_m_q_t_t_publish_info__t.html">MQTTPublishInfo_t</a> * <a class="code hl_variable" href="struct_m_q_t_t_deserialized_info__t.html#ac347273fae1e92b9cbeda1714066c1de">pPublishInfo</a>; </div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno"><a class="line" href="struct_m_q_t_t_deserialized_info__t.html#a7df1b7b60404c9f1604fec0081d2625d"> 236</a></span> <a class="code hl_enumeration" href="group__mqtt__enum__types.html#gaba7ec045874a1c3432f99173367f735c">MQTTStatus_t</a> <a class="code hl_variable" href="struct_m_q_t_t_deserialized_info__t.html#a7df1b7b60404c9f1604fec0081d2625d">deserializationResult</a>; </div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno"> 237</span>} <a class="code hl_struct" href="struct_m_q_t_t_deserialized_info__t.html">MQTTDeserializedInfo_t</a>;</div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno"> 238</span> </div>
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno"> 304</span><span class="comment">/* @[declare_mqtt_init] */</span></div>
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno"> 305</span><a class="code hl_enumeration" href="group__mqtt__enum__types.html#gaba7ec045874a1c3432f99173367f735c">MQTTStatus_t</a> <a class="code hl_function" href="core__mqtt_8h.html#ae8444f3a85535e62cdb1ae9c192677d6">MQTT_Init</a>( <a class="code hl_struct" href="struct_m_q_t_t_context__t.html">MQTTContext_t</a> * pContext,</div>
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno"> 306</span> <span class="keyword">const</span> <a class="code hl_struct" href="struct_transport_interface__t.html">TransportInterface_t</a> * pTransportInterface,</div>
<div class="line"><a id="l00307" name="l00307"></a><span class="lineno"> 307</span> <a class="code hl_typedef" href="group__mqtt__callback__types.html#gae3bea55b0e49e5208b8c5709a5ea23aa">MQTTGetCurrentTimeFunc_t</a> getTimeFunction,</div>
<div class="line"><a id="l00308" name="l00308"></a><span class="lineno"> 308</span> <a class="code hl_typedef" href="group__mqtt__callback__types.html#ga00d348277ed4fde23c95bfc749ae954a">MQTTEventCallback_t</a> userCallback,</div>
<div class="line"><a id="l00309" name="l00309"></a><span class="lineno"> 309</span> <span class="keyword">const</span> <a class="code hl_struct" href="struct_m_q_t_t_fixed_buffer__t.html">MQTTFixedBuffer_t</a> * pNetworkBuffer );</div>
<div class="line"><a id="l00310" name="l00310"></a><span class="lineno"> 310</span><span class="comment">/* @[declare_mqtt_init] */</span></div>
<div class="line"><a id="l00311" name="l00311"></a><span class="lineno"> 311</span> </div>
<div class="line"><a id="l00414" name="l00414"></a><span class="lineno"> 414</span><span class="comment">/* @[declare_mqtt_connect] */</span></div>
<div class="line"><a id="l00415" name="l00415"></a><span class="lineno"> 415</span><a class="code hl_enumeration" href="group__mqtt__enum__types.html#gaba7ec045874a1c3432f99173367f735c">MQTTStatus_t</a> <a class="code hl_function" href="core__mqtt_8h.html#aed1e4dc123a8ba79ac569cb17c69bfa0">MQTT_Connect</a>( <a class="code hl_struct" href="struct_m_q_t_t_context__t.html">MQTTContext_t</a> * pContext,</div>
<div class="line"><a id="l00416" name="l00416"></a><span class="lineno"> 416</span> <span class="keyword">const</span> <a class="code hl_struct" href="struct_m_q_t_t_connect_info__t.html">MQTTConnectInfo_t</a> * pConnectInfo,</div>
<div class="line"><a id="l00417" name="l00417"></a><span class="lineno"> 417</span> <span class="keyword">const</span> <a class="code hl_struct" href="struct_m_q_t_t_publish_info__t.html">MQTTPublishInfo_t</a> * pWillInfo,</div>
<div class="line"><a id="l00418" name="l00418"></a><span class="lineno"> 418</span> uint32_t timeoutMs,</div>
<div class="line"><a id="l00419" name="l00419"></a><span class="lineno"> 419</span> <span class="keywordtype">bool</span> * pSessionPresent );</div>
<div class="line"><a id="l00420" name="l00420"></a><span class="lineno"> 420</span><span class="comment">/* @[declare_mqtt_connect] */</span></div>
<div class="line"><a id="l00421" name="l00421"></a><span class="lineno"> 421</span> </div>
<div class="line"><a id="l00471" name="l00471"></a><span class="lineno"> 471</span><span class="comment">/* @[declare_mqtt_subscribe] */</span></div>
<div class="line"><a id="l00472" name="l00472"></a><span class="lineno"> 472</span><a class="code hl_enumeration" href="group__mqtt__enum__types.html#gaba7ec045874a1c3432f99173367f735c">MQTTStatus_t</a> <a class="code hl_function" href="core__mqtt_8h.html#a567aa9c38726a7879f9cbf943e813e8f">MQTT_Subscribe</a>( <a class="code hl_struct" href="struct_m_q_t_t_context__t.html">MQTTContext_t</a> * pContext,</div>
<div class="line"><a id="l00473" name="l00473"></a><span class="lineno"> 473</span> <span class="keyword">const</span> <a class="code hl_struct" href="struct_m_q_t_t_subscribe_info__t.html">MQTTSubscribeInfo_t</a> * pSubscriptionList,</div>
<div class="line"><a id="l00474" name="l00474"></a><span class="lineno"> 474</span> <span class="keywordtype">size_t</span> subscriptionCount,</div>
<div class="line"><a id="l00475" name="l00475"></a><span class="lineno"> 475</span> uint16_t packetId );</div>
<div class="line"><a id="l00476" name="l00476"></a><span class="lineno"> 476</span><span class="comment">/* @[declare_mqtt_subscribe] */</span></div>
<div class="line"><a id="l00477" name="l00477"></a><span class="lineno"> 477</span> </div>
<div class="line"><a id="l00519" name="l00519"></a><span class="lineno"> 519</span><span class="comment">/* @[declare_mqtt_publish] */</span></div>
<div class="line"><a id="l00520" name="l00520"></a><span class="lineno"> 520</span><a class="code hl_enumeration" href="group__mqtt__enum__types.html#gaba7ec045874a1c3432f99173367f735c">MQTTStatus_t</a> <a class="code hl_function" href="core__mqtt_8h.html#a1d8217e9d30fb2aed002060a8c97c63e">MQTT_Publish</a>( <a class="code hl_struct" href="struct_m_q_t_t_context__t.html">MQTTContext_t</a> * pContext,</div>
<div class="line"><a id="l00521" name="l00521"></a><span class="lineno"> 521</span> <span class="keyword">const</span> <a class="code hl_struct" href="struct_m_q_t_t_publish_info__t.html">MQTTPublishInfo_t</a> * pPublishInfo,</div>
<div class="line"><a id="l00522" name="l00522"></a><span class="lineno"> 522</span> uint16_t packetId );</div>
<div class="line"><a id="l00523" name="l00523"></a><span class="lineno"> 523</span><span class="comment">/* @[declare_mqtt_publish] */</span></div>
<div class="line"><a id="l00524" name="l00524"></a><span class="lineno"> 524</span> </div>
<div class="line"><a id="l00535" name="l00535"></a><span class="lineno"> 535</span><span class="comment">/* @[declare_mqtt_ping] */</span></div>
<div class="line"><a id="l00536" name="l00536"></a><span class="lineno"> 536</span><a class="code hl_enumeration" href="group__mqtt__enum__types.html#gaba7ec045874a1c3432f99173367f735c">MQTTStatus_t</a> <a class="code hl_function" href="core__mqtt_8h.html#a66eced0c62ace790354ae3de40fc0959">MQTT_Ping</a>( <a class="code hl_struct" href="struct_m_q_t_t_context__t.html">MQTTContext_t</a> * pContext );</div>
<div class="line"><a id="l00537" name="l00537"></a><span class="lineno"> 537</span><span class="comment">/* @[declare_mqtt_ping] */</span></div>
<div class="line"><a id="l00538" name="l00538"></a><span class="lineno"> 538</span> </div>
<div class="line"><a id="l00587" name="l00587"></a><span class="lineno"> 587</span><span class="comment">/* @[declare_mqtt_unsubscribe] */</span></div>
<div class="line"><a id="l00588" name="l00588"></a><span class="lineno"> 588</span><a class="code hl_enumeration" href="group__mqtt__enum__types.html#gaba7ec045874a1c3432f99173367f735c">MQTTStatus_t</a> <a class="code hl_function" href="core__mqtt_8h.html#a77c911dbe24c5a51aaea88250895dba4">MQTT_Unsubscribe</a>( <a class="code hl_struct" href="struct_m_q_t_t_context__t.html">MQTTContext_t</a> * pContext,</div>
<div class="line"><a id="l00589" name="l00589"></a><span class="lineno"> 589</span> <span class="keyword">const</span> <a class="code hl_struct" href="struct_m_q_t_t_subscribe_info__t.html">MQTTSubscribeInfo_t</a> * pSubscriptionList,</div>
<div class="line"><a id="l00590" name="l00590"></a><span class="lineno"> 590</span> <span class="keywordtype">size_t</span> subscriptionCount,</div>
<div class="line"><a id="l00591" name="l00591"></a><span class="lineno"> 591</span> uint16_t packetId );</div>
<div class="line"><a id="l00592" name="l00592"></a><span class="lineno"> 592</span><span class="comment">/* @[declare_mqtt_unsubscribe] */</span></div>
<div class="line"><a id="l00593" name="l00593"></a><span class="lineno"> 593</span> </div>
<div class="line"><a id="l00605" name="l00605"></a><span class="lineno"> 605</span><span class="comment">/* @[declare_mqtt_disconnect] */</span></div>
<div class="line"><a id="l00606" name="l00606"></a><span class="lineno"> 606</span><a class="code hl_enumeration" href="group__mqtt__enum__types.html#gaba7ec045874a1c3432f99173367f735c">MQTTStatus_t</a> <a class="code hl_function" href="core__mqtt_8h.html#ac79c366acbc3dddd88072d99ccb9140c">MQTT_Disconnect</a>( <a class="code hl_struct" href="struct_m_q_t_t_context__t.html">MQTTContext_t</a> * pContext );</div>
<div class="line"><a id="l00607" name="l00607"></a><span class="lineno"> 607</span><span class="comment">/* @[declare_mqtt_disconnect] */</span></div>
<div class="line"><a id="l00608" name="l00608"></a><span class="lineno"> 608</span> </div>
<div class="line"><a id="l00666" name="l00666"></a><span class="lineno"> 666</span><span class="comment">/* @[declare_mqtt_processloop] */</span></div>
<div class="line"><a id="l00667" name="l00667"></a><span class="lineno"> 667</span><a class="code hl_enumeration" href="group__mqtt__enum__types.html#gaba7ec045874a1c3432f99173367f735c">MQTTStatus_t</a> <a class="code hl_function" href="core__mqtt_8h.html#adce9111350db412c1256689ef9a7b9f4">MQTT_ProcessLoop</a>( <a class="code hl_struct" href="struct_m_q_t_t_context__t.html">MQTTContext_t</a> * pContext,</div>
<div class="line"><a id="l00668" name="l00668"></a><span class="lineno"> 668</span> uint32_t timeoutMs );</div>
<div class="line"><a id="l00669" name="l00669"></a><span class="lineno"> 669</span><span class="comment">/* @[declare_mqtt_processloop] */</span></div>
<div class="line"><a id="l00670" name="l00670"></a><span class="lineno"> 670</span> </div>
<div class="line"><a id="l00733" name="l00733"></a><span class="lineno"> 733</span><span class="comment">/* @[declare_mqtt_receiveloop] */</span></div>
<div class="line"><a id="l00734" name="l00734"></a><span class="lineno"> 734</span><a class="code hl_enumeration" href="group__mqtt__enum__types.html#gaba7ec045874a1c3432f99173367f735c">MQTTStatus_t</a> <a class="code hl_function" href="core__mqtt_8h.html#a274d7a62c9c011a063031c2e678fb40a">MQTT_ReceiveLoop</a>( <a class="code hl_struct" href="struct_m_q_t_t_context__t.html">MQTTContext_t</a> * pContext,</div>
<div class="line"><a id="l00735" name="l00735"></a><span class="lineno"> 735</span> uint32_t timeoutMs );</div>
<div class="line"><a id="l00736" name="l00736"></a><span class="lineno"> 736</span><span class="comment">/* @[declare_mqtt_receiveloop] */</span></div>
<div class="line"><a id="l00737" name="l00737"></a><span class="lineno"> 737</span> </div>
<div class="line"><a id="l00745" name="l00745"></a><span class="lineno"> 745</span><span class="comment">/* @[declare_mqtt_getpacketid] */</span></div>
<div class="line"><a id="l00746" name="l00746"></a><span class="lineno"> 746</span>uint16_t <a class="code hl_function" href="core__mqtt_8h.html#a00e1a3eba2c21899a6b4312c7d65d090">MQTT_GetPacketId</a>( <a class="code hl_struct" href="struct_m_q_t_t_context__t.html">MQTTContext_t</a> * pContext );</div>
<div class="line"><a id="l00747" name="l00747"></a><span class="lineno"> 747</span><span class="comment">/* @[declare_mqtt_getpacketid] */</span></div>
<div class="line"><a id="l00748" name="l00748"></a><span class="lineno"> 748</span> </div>
<div class="line"><a id="l00791" name="l00791"></a><span class="lineno"> 791</span><a class="code hl_enumeration" href="group__mqtt__enum__types.html#gaba7ec045874a1c3432f99173367f735c">MQTTStatus_t</a> <a class="code hl_function" href="core__mqtt_8h.html#a633409812b18547365ec9b853069021b">MQTT_MatchTopic</a>( <span class="keyword">const</span> <span class="keywordtype">char</span> * pTopicName,</div>
<div class="line"><a id="l00792" name="l00792"></a><span class="lineno"> 792</span> <span class="keyword">const</span> uint16_t topicNameLength,</div>
<div class="line"><a id="l00793" name="l00793"></a><span class="lineno"> 793</span> <span class="keyword">const</span> <span class="keywordtype">char</span> * pTopicFilter,</div>
<div class="line"><a id="l00794" name="l00794"></a><span class="lineno"> 794</span> <span class="keyword">const</span> uint16_t topicFilterLength,</div>
<div class="line"><a id="l00795" name="l00795"></a><span class="lineno"> 795</span> <span class="keywordtype">bool</span> * pIsMatch );</div>
<div class="line"><a id="l00796" name="l00796"></a><span class="lineno"> 796</span> </div>
<div class="line"><a id="l00879" name="l00879"></a><span class="lineno"> 879</span><span class="comment">/* @[declare_mqtt_getsubackstatuscodes] */</span></div>
<div class="line"><a id="l00880" name="l00880"></a><span class="lineno"> 880</span><a class="code hl_enumeration" href="group__mqtt__enum__types.html#gaba7ec045874a1c3432f99173367f735c">MQTTStatus_t</a> <a class="code hl_function" href="core__mqtt_8h.html#ac43449e06856c6703cda73359c222bd2">MQTT_GetSubAckStatusCodes</a>( <span class="keyword">const</span> <a class="code hl_struct" href="struct_m_q_t_t_packet_info__t.html">MQTTPacketInfo_t</a> * pSubackPacket,</div>
<div class="line"><a id="l00881" name="l00881"></a><span class="lineno"> 881</span> uint8_t ** pPayloadStart,</div>
<div class="line"><a id="l00882" name="l00882"></a><span class="lineno"> 882</span> <span class="keywordtype">size_t</span> * pPayloadSize );</div>
<div class="line"><a id="l00883" name="l00883"></a><span class="lineno"> 883</span><span class="comment">/* @[declare_mqtt_getsubackstatuscodes] */</span></div>
<div class="line"><a id="l00884" name="l00884"></a><span class="lineno"> 884</span> </div>
<div class="line"><a id="l00892" name="l00892"></a><span class="lineno"> 892</span><span class="comment">/* @[declare_mqtt_status_strerror] */</span></div>
<div class="line"><a id="l00893" name="l00893"></a><span class="lineno"> 893</span><span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code hl_function" href="core__mqtt_8h.html#a05d9facfce89c5f9edef09ca13717f50">MQTT_Status_strerror</a>( <a class="code hl_enumeration" href="group__mqtt__enum__types.html#gaba7ec045874a1c3432f99173367f735c">MQTTStatus_t</a> status );</div>
<div class="line"><a id="l00894" name="l00894"></a><span class="lineno"> 894</span><span class="comment">/* @[declare_mqtt_status_strerror] */</span></div>
<div class="line"><a id="l00895" name="l00895"></a><span class="lineno"> 895</span> </div>
<div class="line"><a id="l00896" name="l00896"></a><span class="lineno"> 896</span><span class="comment">/* *INDENT-OFF* */</span></div>
<div class="line"><a id="l00897" name="l00897"></a><span class="lineno"> 897</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00898" name="l00898"></a><span class="lineno"> 898</span> }</div>
<div class="line"><a id="l00899" name="l00899"></a><span class="lineno"> 899</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00900" name="l00900"></a><span class="lineno"> 900</span><span class="comment">/* *INDENT-ON* */</span></div>
<div class="line"><a id="l00901" name="l00901"></a><span class="lineno"> 901</span> </div>
<div class="line"><a id="l00902" name="l00902"></a><span class="lineno"> 902</span><span class="preprocessor">#endif </span><span class="comment">/* ifndef CORE_MQTT_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="acore__mqtt_8h_html_a00e1a3eba2c21899a6b4312c7d65d090"><div class="ttname"><a href="core__mqtt_8h.html#a00e1a3eba2c21899a6b4312c7d65d090">MQTT_GetPacketId</a></div><div class="ttdeci">uint16_t MQTT_GetPacketId(MQTTContext_t *pContext)</div><div class="ttdoc">Get a packet ID that is valid according to the MQTT 3.1.1 spec.</div><div class="ttdef"><b>Definition:</b> core_mqtt.c:2279</div></div>
<div class="ttc" id="acore__mqtt_8h_html_a05d9facfce89c5f9edef09ca13717f50"><div class="ttname"><a href="core__mqtt_8h.html#a05d9facfce89c5f9edef09ca13717f50">MQTT_Status_strerror</a></div><div class="ttdeci">const char * MQTT_Status_strerror(MQTTStatus_t status)</div><div class="ttdoc">Error code to string conversion for MQTT statuses.</div><div class="ttdef"><b>Definition:</b> core_mqtt.c:2432</div></div>
<div class="ttc" id="acore__mqtt_8h_html_a1d8217e9d30fb2aed002060a8c97c63e"><div class="ttname"><a href="core__mqtt_8h.html#a1d8217e9d30fb2aed002060a8c97c63e">MQTT_Publish</a></div><div class="ttdeci">MQTTStatus_t MQTT_Publish(MQTTContext_t *pContext, const MQTTPublishInfo_t *pPublishInfo, uint16_t packetId)</div><div class="ttdoc">Publishes a message to the given topic name.</div><div class="ttdef"><b>Definition:</b> core_mqtt.c:1916</div></div>
<div class="ttc" id="acore__mqtt_8h_html_a274d7a62c9c011a063031c2e678fb40a"><div class="ttname"><a href="core__mqtt_8h.html#a274d7a62c9c011a063031c2e678fb40a">MQTT_ReceiveLoop</a></div><div class="ttdeci">MQTTStatus_t MQTT_ReceiveLoop(MQTTContext_t *pContext, uint32_t timeoutMs)</div><div class="ttdoc">Loop to receive packets from the transport interface. Does not handle keep alive.</div><div class="ttdef"><b>Definition:</b> core_mqtt.c:2224</div></div>
<div class="ttc" id="acore__mqtt_8h_html_a567aa9c38726a7879f9cbf943e813e8f"><div class="ttname"><a href="core__mqtt_8h.html#a567aa9c38726a7879f9cbf943e813e8f">MQTT_Subscribe</a></div><div class="ttdeci">MQTTStatus_t MQTT_Subscribe(MQTTContext_t *pContext, const MQTTSubscribeInfo_t *pSubscriptionList, size_t subscriptionCount, uint16_t packetId)</div><div class="ttdoc">Sends MQTT SUBSCRIBE for the given list of topic filters to the broker.</div><div class="ttdef"><b>Definition:</b> core_mqtt.c:1856</div></div>
<div class="ttc" id="acore__mqtt_8h_html_a633409812b18547365ec9b853069021b"><div class="ttname"><a href="core__mqtt_8h.html#a633409812b18547365ec9b853069021b">MQTT_MatchTopic</a></div><div class="ttdeci">MQTTStatus_t MQTT_MatchTopic(const char *pTopicName, const uint16_t topicNameLength, const char *pTopicFilter, const uint16_t topicFilterLength, bool *pIsMatch)</div><div class="ttdoc">A utility function that determines whether the passed topic filter and topic name match according to ...</div><div class="ttdef"><b>Definition:</b> core_mqtt.c:2304</div></div>
<div class="ttc" id="acore__mqtt_8h_html_a66eced0c62ace790354ae3de40fc0959"><div class="ttname"><a href="core__mqtt_8h.html#a66eced0c62ace790354ae3de40fc0959">MQTT_Ping</a></div><div class="ttdeci">MQTTStatus_t MQTT_Ping(MQTTContext_t *pContext)</div><div class="ttdoc">Sends an MQTT PINGREQ to broker.</div><div class="ttdef"><b>Definition:</b> core_mqtt.c:1990</div></div>
<div class="ttc" id="acore__mqtt_8h_html_a77c911dbe24c5a51aaea88250895dba4"><div class="ttname"><a href="core__mqtt_8h.html#a77c911dbe24c5a51aaea88250895dba4">MQTT_Unsubscribe</a></div><div class="ttdeci">MQTTStatus_t MQTT_Unsubscribe(MQTTContext_t *pContext, const MQTTSubscribeInfo_t *pSubscriptionList, size_t subscriptionCount, uint16_t packetId)</div><div class="ttdoc">Sends MQTT UNSUBSCRIBE for the given list of topic filters to the broker.</div><div class="ttdef"><b>Definition:</b> core_mqtt.c:2051</div></div>
<div class="ttc" id="acore__mqtt_8h_html_ac43449e06856c6703cda73359c222bd2"><div class="ttname"><a href="core__mqtt_8h.html#ac43449e06856c6703cda73359c222bd2">MQTT_GetSubAckStatusCodes</a></div><div class="ttdeci">MQTTStatus_t MQTT_GetSubAckStatusCodes(const MQTTPacketInfo_t *pSubackPacket, uint8_t **pPayloadStart, size_t *pPayloadSize)</div><div class="ttdoc">Parses the payload of an MQTT SUBACK packet that contains status codes corresponding to topic filter ...</div><div class="ttdef"><b>Definition:</b> core_mqtt.c:2373</div></div>
<div class="ttc" id="acore__mqtt_8h_html_ac79c366acbc3dddd88072d99ccb9140c"><div class="ttname"><a href="core__mqtt_8h.html#ac79c366acbc3dddd88072d99ccb9140c">MQTT_Disconnect</a></div><div class="ttdeci">MQTTStatus_t MQTT_Disconnect(MQTTContext_t *pContext)</div><div class="ttdoc">Disconnect an MQTT session.</div><div class="ttdef"><b>Definition:</b> core_mqtt.c:2111</div></div>
<div class="ttc" id="acore__mqtt_8h_html_adce9111350db412c1256689ef9a7b9f4"><div class="ttname"><a href="core__mqtt_8h.html#adce9111350db412c1256689ef9a7b9f4">MQTT_ProcessLoop</a></div><div class="ttdeci">MQTTStatus_t MQTT_ProcessLoop(MQTTContext_t *pContext, uint32_t timeoutMs)</div><div class="ttdoc">Loop to receive packets from the transport interface. Handles keep alive.</div><div class="ttdef"><b>Definition:</b> core_mqtt.c:2167</div></div>
<div class="ttc" id="acore__mqtt_8h_html_ae8444f3a85535e62cdb1ae9c192677d6"><div class="ttname"><a href="core__mqtt_8h.html#ae8444f3a85535e62cdb1ae9c192677d6">MQTT_Init</a></div><div class="ttdeci">MQTTStatus_t MQTT_Init(MQTTContext_t *pContext, const TransportInterface_t *pTransportInterface, MQTTGetCurrentTimeFunc_t getTimeFunction, MQTTEventCallback_t userCallback, const MQTTFixedBuffer_t *pNetworkBuffer)</div><div class="ttdoc">Initialize an MQTT context.</div><div class="ttdef"><b>Definition:</b> core_mqtt.c:1700</div></div>
<div class="ttc" id="acore__mqtt_8h_html_aed1e4dc123a8ba79ac569cb17c69bfa0"><div class="ttname"><a href="core__mqtt_8h.html#aed1e4dc123a8ba79ac569cb17c69bfa0">MQTT_Connect</a></div><div class="ttdeci">MQTTStatus_t MQTT_Connect(MQTTContext_t *pContext, const MQTTConnectInfo_t *pConnectInfo, const MQTTPublishInfo_t *pWillInfo, uint32_t timeoutMs, bool *pSessionPresent)</div><div class="ttdoc">Establish an MQTT session.</div><div class="ttdef"><b>Definition:</b> core_mqtt.c:1759</div></div>
<div class="ttc" id="acore__mqtt__config__defaults_8h_html"><div class="ttname"><a href="core__mqtt__config__defaults_8h.html">core_mqtt_config_defaults.h</a></div><div class="ttdoc">This represents the default values for the configuration macros for the MQTT library.</div></div>
<div class="ttc" id="acore__mqtt__config__defaults_8h_html_a50b149716607c0b7974c391830f1b007"><div class="ttname"><a href="core__mqtt__config__defaults_8h.html#a50b149716607c0b7974c391830f1b007">MQTT_STATE_ARRAY_MAX_COUNT</a></div><div class="ttdeci">#define MQTT_STATE_ARRAY_MAX_COUNT</div><div class="ttdoc">Determines the maximum number of MQTT PUBLISH messages, pending acknowledgment at a time,...</div><div class="ttdef"><b>Definition:</b> core_mqtt_config_defaults.h:82</div></div>
<div class="ttc" id="acore__mqtt__serializer_8h_html"><div class="ttname"><a href="core__mqtt__serializer_8h.html">core_mqtt_serializer.h</a></div><div class="ttdoc">User-facing functions for serializing and deserializing MQTT 3.1.1 packets. This header should be inc...</div></div>
<div class="ttc" id="agroup__mqtt__callback__types_html_ga00d348277ed4fde23c95bfc749ae954a"><div class="ttname"><a href="group__mqtt__callback__types.html#ga00d348277ed4fde23c95bfc749ae954a">MQTTEventCallback_t</a></div><div class="ttdeci">void(* MQTTEventCallback_t)(struct MQTTContext *pContext, struct MQTTPacketInfo *pPacketInfo, struct MQTTDeserializedInfo *pDeserializedInfo)</div><div class="ttdoc">Application callback for receiving incoming publishes and incoming acks.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:96</div></div>
<div class="ttc" id="agroup__mqtt__callback__types_html_gae3bea55b0e49e5208b8c5709a5ea23aa"><div class="ttname"><a href="group__mqtt__callback__types.html#gae3bea55b0e49e5208b8c5709a5ea23aa">MQTTGetCurrentTimeFunc_t</a></div><div class="ttdeci">uint32_t(* MQTTGetCurrentTimeFunc_t)(void)</div><div class="ttdoc">Application provided function to query the current time in milliseconds.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:81</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_ga0480de7552eedd739a26a23fa8e6fd94"><div class="ttname"><a href="group__mqtt__enum__types.html#ga0480de7552eedd739a26a23fa8e6fd94">MQTTPublishState_t</a></div><div class="ttdeci">MQTTPublishState_t</div><div class="ttdoc">The state of QoS 1 or QoS 2 MQTT publishes, used in the state engine.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:115</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_ga48dabc1579e3c0ac6058ce9068054611"><div class="ttname"><a href="group__mqtt__enum__types.html#ga48dabc1579e3c0ac6058ce9068054611">MQTTSubAckStatus_t</a></div><div class="ttdeci">MQTTSubAckStatus_t</div><div class="ttdoc">The status codes in the SUBACK response to a subscription request.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:146</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_ga8c1bee959b3ed5fab2a2688dd72bf237"><div class="ttname"><a href="group__mqtt__enum__types.html#ga8c1bee959b3ed5fab2a2688dd72bf237">MQTTPubAckType_t</a></div><div class="ttdeci">MQTTPubAckType_t</div><div class="ttdoc">Packet types used in acknowledging QoS 1 or QoS 2 publishes.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:134</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_ga9f84d003695205cf10a7bd0bafb3dbf6"><div class="ttname"><a href="group__mqtt__enum__types.html#ga9f84d003695205cf10a7bd0bafb3dbf6">MQTTConnectionStatus_t</a></div><div class="ttdeci">MQTTConnectionStatus_t</div><div class="ttdoc">Values indicating if an MQTT connection exists.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:105</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_gaba7ec045874a1c3432f99173367f735c"><div class="ttname"><a href="group__mqtt__enum__types.html#gaba7ec045874a1c3432f99173367f735c">MQTTStatus_t</a></div><div class="ttdeci">MQTTStatus_t</div><div class="ttdoc">Return codes from MQTT functions.</div><div class="ttdef"><b>Definition:</b> core_mqtt_serializer.h:97</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_gae308a5928d7f537379c29a894228093a"><div class="ttname"><a href="group__mqtt__enum__types.html#gae308a5928d7f537379c29a894228093a">MQTTQoS_t</a></div><div class="ttdeci">MQTTQoS_t</div><div class="ttdoc">MQTT Quality of Service values.</div><div class="ttdef"><b>Definition:</b> core_mqtt_serializer.h:116</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_gga0480de7552eedd739a26a23fa8e6fd94a11e2319a2b25b82121471743d39761e1"><div class="ttname"><a href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a11e2319a2b25b82121471743d39761e1">MQTTPubRecSend</a></div><div class="ttdeci">@ MQTTPubRecSend</div><div class="ttdoc">The library will send a PUBREC for a received PUBLISH.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:119</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_gga0480de7552eedd739a26a23fa8e6fd94a1bea59454700be9b683b7eb8aaf6bb4f"><div class="ttname"><a href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a1bea59454700be9b683b7eb8aaf6bb4f">MQTTPubRecPending</a></div><div class="ttdeci">@ MQTTPubRecPending</div><div class="ttdoc">The library is awaiting a PUBREC for an outgoing PUBLISH.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:123</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_gga0480de7552eedd739a26a23fa8e6fd94a3281a28d1829d954b596f091b547b627"><div class="ttname"><a href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a3281a28d1829d954b596f091b547b627">MQTTPubCompPending</a></div><div class="ttdeci">@ MQTTPubCompPending</div><div class="ttdoc">The library is awaiting a PUBCOMP for an outgoing PUBLISH.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:125</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_gga0480de7552eedd739a26a23fa8e6fd94a5d2ee2709c6dc7a1eb8b9c40f318909b"><div class="ttname"><a href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a5d2ee2709c6dc7a1eb8b9c40f318909b">MQTTPubRelSend</a></div><div class="ttdeci">@ MQTTPubRelSend</div><div class="ttdoc">The library will send a PUBREL for a received PUBREC.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:120</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_gga0480de7552eedd739a26a23fa8e6fd94a65f6f7b343a30fc0558e3aeeb8c97f35"><div class="ttname"><a href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a65f6f7b343a30fc0558e3aeeb8c97f35">MQTTPubAckSend</a></div><div class="ttdeci">@ MQTTPubAckSend</div><div class="ttdoc">The library will send a PUBACK for a received PUBLISH.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:118</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_gga0480de7552eedd739a26a23fa8e6fd94a695431cde1dc9dc5a2dcbd10eba49df2"><div class="ttname"><a href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a695431cde1dc9dc5a2dcbd10eba49df2">MQTTPubRelPending</a></div><div class="ttdeci">@ MQTTPubRelPending</div><div class="ttdoc">The library is awaiting a PUBREL for an incoming PUBLISH.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:124</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_gga0480de7552eedd739a26a23fa8e6fd94a7d88904d550b502b4424a41aa4205e56"><div class="ttname"><a href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a7d88904d550b502b4424a41aa4205e56">MQTTPubCompSend</a></div><div class="ttdeci">@ MQTTPubCompSend</div><div class="ttdoc">The library will send a PUBCOMP for a received PUBREL.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:121</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_gga0480de7552eedd739a26a23fa8e6fd94a8349567b7a9efb3913a64a8f4f6fe5c9"><div class="ttname"><a href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a8349567b7a9efb3913a64a8f4f6fe5c9">MQTTStateNull</a></div><div class="ttdeci">@ MQTTStateNull</div><div class="ttdoc">An empty state with no corresponding PUBLISH.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:116</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_gga0480de7552eedd739a26a23fa8e6fd94a896b1507647b504c9208580e4cde26ad"><div class="ttname"><a href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94a896b1507647b504c9208580e4cde26ad">MQTTPublishSend</a></div><div class="ttdeci">@ MQTTPublishSend</div><div class="ttdoc">The library will send an outgoing PUBLISH packet.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:117</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_gga0480de7552eedd739a26a23fa8e6fd94ab086c55acf106cdc8d420f90899b6803"><div class="ttname"><a href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94ab086c55acf106cdc8d420f90899b6803">MQTTPubAckPending</a></div><div class="ttdeci">@ MQTTPubAckPending</div><div class="ttdoc">The library is awaiting a PUBACK for an outgoing PUBLISH.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:122</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_gga0480de7552eedd739a26a23fa8e6fd94ad07733793a235ef9a6a04d16637cd7dc"><div class="ttname"><a href="group__mqtt__enum__types.html#gga0480de7552eedd739a26a23fa8e6fd94ad07733793a235ef9a6a04d16637cd7dc">MQTTPublishDone</a></div><div class="ttdeci">@ MQTTPublishDone</div><div class="ttdoc">The PUBLISH has been completed.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:126</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_gga48dabc1579e3c0ac6058ce9068054611a877b2afbc6ec7d9ab57d4862caadf4f1"><div class="ttname"><a href="group__mqtt__enum__types.html#gga48dabc1579e3c0ac6058ce9068054611a877b2afbc6ec7d9ab57d4862caadf4f1">MQTTSubAckSuccessQos2</a></div><div class="ttdeci">@ MQTTSubAckSuccessQos2</div><div class="ttdoc">Success with a maximum delivery at QoS 2.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:149</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_gga48dabc1579e3c0ac6058ce9068054611ab180361a6da712c8144d8c499537787d"><div class="ttname"><a href="group__mqtt__enum__types.html#gga48dabc1579e3c0ac6058ce9068054611ab180361a6da712c8144d8c499537787d">MQTTSubAckSuccessQos1</a></div><div class="ttdeci">@ MQTTSubAckSuccessQos1</div><div class="ttdoc">Success with a maximum delivery at QoS 1.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:148</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_gga48dabc1579e3c0ac6058ce9068054611abcc3040d7d53025baee3542c40758abb"><div class="ttname"><a href="group__mqtt__enum__types.html#gga48dabc1579e3c0ac6058ce9068054611abcc3040d7d53025baee3542c40758abb">MQTTSubAckSuccessQos0</a></div><div class="ttdeci">@ MQTTSubAckSuccessQos0</div><div class="ttdoc">Success with a maximum delivery at QoS 0.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:147</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_gga48dabc1579e3c0ac6058ce9068054611aeb83b20da8eda934cde6b92db225a808"><div class="ttname"><a href="group__mqtt__enum__types.html#gga48dabc1579e3c0ac6058ce9068054611aeb83b20da8eda934cde6b92db225a808">MQTTSubAckFailure</a></div><div class="ttdeci">@ MQTTSubAckFailure</div><div class="ttdoc">Failure.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:150</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_gga8c1bee959b3ed5fab2a2688dd72bf237a53d5939c680962f37c15ee87ffd63d0f"><div class="ttname"><a href="group__mqtt__enum__types.html#gga8c1bee959b3ed5fab2a2688dd72bf237a53d5939c680962f37c15ee87ffd63d0f">MQTTPuback</a></div><div class="ttdeci">@ MQTTPuback</div><div class="ttdoc">PUBACKs are sent in response to a QoS 1 PUBLISH.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:135</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_gga8c1bee959b3ed5fab2a2688dd72bf237a8c98d5d1a68dda33d9039009ab4ef053"><div class="ttname"><a href="group__mqtt__enum__types.html#gga8c1bee959b3ed5fab2a2688dd72bf237a8c98d5d1a68dda33d9039009ab4ef053">MQTTPubrec</a></div><div class="ttdeci">@ MQTTPubrec</div><div class="ttdoc">PUBRECs are sent in response to a QoS 2 PUBLISH.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:136</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_gga8c1bee959b3ed5fab2a2688dd72bf237a910c34311ad6a2341afc04839e1c13bd"><div class="ttname"><a href="group__mqtt__enum__types.html#gga8c1bee959b3ed5fab2a2688dd72bf237a910c34311ad6a2341afc04839e1c13bd">MQTTPubcomp</a></div><div class="ttdeci">@ MQTTPubcomp</div><div class="ttdoc">PUBCOMPs are sent in response to a PUBREL.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:138</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_gga8c1bee959b3ed5fab2a2688dd72bf237af2d737088a231c88e7603acfdbc4fc8c"><div class="ttname"><a href="group__mqtt__enum__types.html#gga8c1bee959b3ed5fab2a2688dd72bf237af2d737088a231c88e7603acfdbc4fc8c">MQTTPubrel</a></div><div class="ttdeci">@ MQTTPubrel</div><div class="ttdoc">PUBRELs are sent in response to a PUBREC.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:137</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_gga9f84d003695205cf10a7bd0bafb3dbf6a0320177ebf1f1b2e24646b44702cec69"><div class="ttname"><a href="group__mqtt__enum__types.html#gga9f84d003695205cf10a7bd0bafb3dbf6a0320177ebf1f1b2e24646b44702cec69">MQTTNotConnected</a></div><div class="ttdeci">@ MQTTNotConnected</div><div class="ttdoc">MQTT Connection is inactive.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:106</div></div>
<div class="ttc" id="agroup__mqtt__enum__types_html_gga9f84d003695205cf10a7bd0bafb3dbf6a82c8f64d976734e5632e5257bc429ef5"><div class="ttname"><a href="group__mqtt__enum__types.html#gga9f84d003695205cf10a7bd0bafb3dbf6a82c8f64d976734e5632e5257bc429ef5">MQTTConnected</a></div><div class="ttdeci">@ MQTTConnected</div><div class="ttdoc">MQTT Connection is active.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:107</div></div>
<div class="ttc" id="astruct_m_q_t_t_connect_info__t_html"><div class="ttname"><a href="struct_m_q_t_t_connect_info__t.html">MQTTConnectInfo_t</a></div><div class="ttdoc">MQTT CONNECT packet parameters.</div><div class="ttdef"><b>Definition:</b> core_mqtt_serializer.h:140</div></div>
<div class="ttc" id="astruct_m_q_t_t_context__t_html"><div class="ttname"><a href="struct_m_q_t_t_context__t.html">MQTTContext_t</a></div><div class="ttdoc">A struct representing an MQTT connection.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:169</div></div>
<div class="ttc" id="astruct_m_q_t_t_context__t_html_a231c5576a6ce389317a3f00f95628276"><div class="ttname"><a href="struct_m_q_t_t_context__t.html#a231c5576a6ce389317a3f00f95628276">MQTTContext_t::networkBuffer</a></div><div class="ttdeci">MQTTFixedBuffer_t networkBuffer</div><div class="ttdoc">The buffer used in sending and receiving packets from the network.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:188</div></div>
<div class="ttc" id="astruct_m_q_t_t_context__t_html_a4e38c4dc77e7751a0ad8730a41bee47f"><div class="ttname"><a href="struct_m_q_t_t_context__t.html#a4e38c4dc77e7751a0ad8730a41bee47f">MQTTContext_t::connectStatus</a></div><div class="ttdeci">MQTTConnectionStatus_t connectStatus</div><div class="ttdoc">Whether the context currently has a connection to the broker.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:198</div></div>
<div class="ttc" id="astruct_m_q_t_t_context__t_html_a73bd9259db9c3a9b84518cbf928ed91f"><div class="ttname"><a href="struct_m_q_t_t_context__t.html#a73bd9259db9c3a9b84518cbf928ed91f">MQTTContext_t::appCallback</a></div><div class="ttdeci">MQTTEventCallback_t appCallback</div><div class="ttdoc">Callback function used to give deserialized MQTT packets to the application.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:208</div></div>
<div class="ttc" id="astruct_m_q_t_t_context__t_html_a87ab9d61e7711325c2c85ce3ce63386a"><div class="ttname"><a href="struct_m_q_t_t_context__t.html#a87ab9d61e7711325c2c85ce3ce63386a">MQTTContext_t::transportInterface</a></div><div class="ttdeci">TransportInterface_t transportInterface</div><div class="ttdoc">The transport interface used by the MQTT connection.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:183</div></div>
<div class="ttc" id="astruct_m_q_t_t_context__t_html_aabe1d302a16771292151013e8e30c582"><div class="ttname"><a href="struct_m_q_t_t_context__t.html#aabe1d302a16771292151013e8e30c582">MQTTContext_t::getTime</a></div><div class="ttdeci">MQTTGetCurrentTimeFunc_t getTime</div><div class="ttdoc">Function used to get millisecond timestamps.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:203</div></div>
<div class="ttc" id="astruct_m_q_t_t_context__t_html_abd7afb708927ec69530408defa192d2f"><div class="ttname"><a href="struct_m_q_t_t_context__t.html#abd7afb708927ec69530408defa192d2f">MQTTContext_t::lastPacketTime</a></div><div class="ttdeci">uint32_t lastPacketTime</div><div class="ttdoc">Timestamp of the last packet sent by the library.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:213</div></div>
<div class="ttc" id="astruct_m_q_t_t_context__t_html_ac7073f43645f7b7c0c5b7763980004bb"><div class="ttname"><a href="struct_m_q_t_t_context__t.html#ac7073f43645f7b7c0c5b7763980004bb">MQTTContext_t::waitingForPingResp</a></div><div class="ttdeci">bool waitingForPingResp</div><div class="ttdoc">If the library is currently awaiting a PINGRESP.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:224</div></div>
<div class="ttc" id="astruct_m_q_t_t_context__t_html_acca3efa4146d85f7e874c7c326e23556"><div class="ttname"><a href="struct_m_q_t_t_context__t.html#acca3efa4146d85f7e874c7c326e23556">MQTTContext_t::pingReqSendTimeMs</a></div><div class="ttdeci">uint32_t pingReqSendTimeMs</div><div class="ttdoc">Timestamp of the last sent PINGREQ.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:223</div></div>
<div class="ttc" id="astruct_m_q_t_t_context__t_html_af47ed55ad7e9bb112324f5f209b70534"><div class="ttname"><a href="struct_m_q_t_t_context__t.html#af47ed55ad7e9bb112324f5f209b70534">MQTTContext_t::nextPacketId</a></div><div class="ttdeci">uint16_t nextPacketId</div><div class="ttdoc">The next available ID for outgoing MQTT packets.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:193</div></div>
<div class="ttc" id="astruct_m_q_t_t_context__t_html_af9724f2426132e3ce96a03892902ef89"><div class="ttname"><a href="struct_m_q_t_t_context__t.html#af9724f2426132e3ce96a03892902ef89">MQTTContext_t::controlPacketSent</a></div><div class="ttdeci">bool controlPacketSent</div><div class="ttdoc">Whether the library sent a packet during a call of MQTT_ProcessLoop or MQTT_ReceiveLoop.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:219</div></div>
<div class="ttc" id="astruct_m_q_t_t_context__t_html_afd6071827ef48b230212a5725c2075be"><div class="ttname"><a href="struct_m_q_t_t_context__t.html#afd6071827ef48b230212a5725c2075be">MQTTContext_t::keepAliveIntervalSec</a></div><div class="ttdeci">uint16_t keepAliveIntervalSec</div><div class="ttdoc">Keep Alive interval.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:222</div></div>
<div class="ttc" id="astruct_m_q_t_t_deserialized_info__t_html"><div class="ttname"><a href="struct_m_q_t_t_deserialized_info__t.html">MQTTDeserializedInfo_t</a></div><div class="ttdoc">Struct to hold deserialized packet information for an MQTTEventCallback_t callback.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:233</div></div>
<div class="ttc" id="astruct_m_q_t_t_deserialized_info__t_html_a7df1b7b60404c9f1604fec0081d2625d"><div class="ttname"><a href="struct_m_q_t_t_deserialized_info__t.html#a7df1b7b60404c9f1604fec0081d2625d">MQTTDeserializedInfo_t::deserializationResult</a></div><div class="ttdeci">MQTTStatus_t deserializationResult</div><div class="ttdoc">Return code of deserialization.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:236</div></div>
<div class="ttc" id="astruct_m_q_t_t_deserialized_info__t_html_ac347273fae1e92b9cbeda1714066c1de"><div class="ttname"><a href="struct_m_q_t_t_deserialized_info__t.html#ac347273fae1e92b9cbeda1714066c1de">MQTTDeserializedInfo_t::pPublishInfo</a></div><div class="ttdeci">MQTTPublishInfo_t * pPublishInfo</div><div class="ttdoc">Pointer to deserialized publish info.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:235</div></div>
<div class="ttc" id="astruct_m_q_t_t_deserialized_info__t_html_af4df2a9926a4a68059195daa712d9b84"><div class="ttname"><a href="struct_m_q_t_t_deserialized_info__t.html#af4df2a9926a4a68059195daa712d9b84">MQTTDeserializedInfo_t::packetIdentifier</a></div><div class="ttdeci">uint16_t packetIdentifier</div><div class="ttdoc">Packet ID of deserialized packet.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:234</div></div>
<div class="ttc" id="astruct_m_q_t_t_fixed_buffer__t_html"><div class="ttname"><a href="struct_m_q_t_t_fixed_buffer__t.html">MQTTFixedBuffer_t</a></div><div class="ttdoc">Buffer passed to MQTT library.</div><div class="ttdef"><b>Definition:</b> core_mqtt_serializer.h:130</div></div>
<div class="ttc" id="astruct_m_q_t_t_packet_info__t_html"><div class="ttname"><a href="struct_m_q_t_t_packet_info__t.html">MQTTPacketInfo_t</a></div><div class="ttdoc">MQTT incoming packet parameters.</div><div class="ttdef"><b>Definition:</b> core_mqtt_serializer.h:251</div></div>
<div class="ttc" id="astruct_m_q_t_t_pub_ack_info__t_html"><div class="ttname"><a href="struct_m_q_t_t_pub_ack_info__t.html">MQTTPubAckInfo_t</a></div><div class="ttdoc">An element of the state engine records for QoS 1 or Qos 2 publishes.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:158</div></div>
<div class="ttc" id="astruct_m_q_t_t_pub_ack_info__t_html_a086fcd48ef0b787697526a95c861e8a0"><div class="ttname"><a href="struct_m_q_t_t_pub_ack_info__t.html#a086fcd48ef0b787697526a95c861e8a0">MQTTPubAckInfo_t::qos</a></div><div class="ttdeci">MQTTQoS_t qos</div><div class="ttdoc">The QoS of the original PUBLISH.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:160</div></div>
<div class="ttc" id="astruct_m_q_t_t_pub_ack_info__t_html_a61314203ef87a231c6489c68b579de34"><div class="ttname"><a href="struct_m_q_t_t_pub_ack_info__t.html#a61314203ef87a231c6489c68b579de34">MQTTPubAckInfo_t::publishState</a></div><div class="ttdeci">MQTTPublishState_t publishState</div><div class="ttdoc">The current state of the publish process.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:161</div></div>
<div class="ttc" id="astruct_m_q_t_t_pub_ack_info__t_html_a66cef7b43af5d7fdd33b5d2dc766b2d0"><div class="ttname"><a href="struct_m_q_t_t_pub_ack_info__t.html#a66cef7b43af5d7fdd33b5d2dc766b2d0">MQTTPubAckInfo_t::packetId</a></div><div class="ttdeci">uint16_t packetId</div><div class="ttdoc">The packet ID of the original PUBLISH.</div><div class="ttdef"><b>Definition:</b> core_mqtt.h:159</div></div>
<div class="ttc" id="astruct_m_q_t_t_publish_info__t_html"><div class="ttname"><a href="struct_m_q_t_t_publish_info__t.html">MQTTPublishInfo_t</a></div><div class="ttdoc">MQTT PUBLISH packet parameters.</div><div class="ttdef"><b>Definition:</b> core_mqtt_serializer.h:209</div></div>
<div class="ttc" id="astruct_m_q_t_t_subscribe_info__t_html"><div class="ttname"><a href="struct_m_q_t_t_subscribe_info__t.html">MQTTSubscribeInfo_t</a></div><div class="ttdoc">MQTT SUBSCRIBE packet parameters.</div><div class="ttdef"><b>Definition:</b> core_mqtt_serializer.h:187</div></div>
<div class="ttc" id="astruct_transport_interface__t_html"><div class="ttname"><a href="struct_transport_interface__t.html">TransportInterface_t</a></div><div class="ttdoc">The transport layer interface.</div><div class="ttdef"><b>Definition:</b> transport_interface.h:252</div></div>
<div class="ttc" id="atransport__interface_8h_html"><div class="ttname"><a href="transport__interface_8h.html">transport_interface.h</a></div><div class="ttdoc">Transport interface definitions to send and receive data over the network.</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_b2f33c71d4aa5e7af42a1ca61ff5af1b.html">source</a></li><li class="navelem"><a class="el" href="dir_8ee1a5e78eaec319fe5d64075812fc61.html">include</a></li><li class="navelem"><a class="el" href="core__mqtt_8h.html">core_mqtt.h</a></li>
<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.2 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink