mirror of
https://github.com/FreeRTOS/coreMQTT
synced 2025-06-02 05:51:38 +08:00
165 lines
16 KiB
HTML
165 lines
16 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">
|
|
<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: Related Pages</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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">coreMQTT<span id="projectnumber"> 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&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&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('pages.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">Related Pages</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock">Here is a list of all related documentation pages:</div><div class="directory">
|
|
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
|
|
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="mqtt_design.html" target="_self">Design</a></td><td class="desc">Architecture of the MQTT library </td></tr>
|
|
<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="core_mqtt_config.html" target="_self">Configurations</a></td><td class="desc">Configurations of the MQTT Library </td></tr>
|
|
<tr id="row_2_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_2_" class="arrow" onclick="toggleFolder('2_')">▼</span><a class="el" href="mqtt_functions.html" target="_self">Functions</a></td><td class="desc">Primary functions of the MQTT library:<br />
|
|
<br />
|
|
<a class="el" href="mqtt_init_function.html">MQTT_Init</a> <br />
|
|
<a class="el" href="mqtt_connect_function.html">MQTT_Connect</a> <br />
|
|
<a class="el" href="mqtt_subscribe_function.html">MQTT_Subscribe</a> <br />
|
|
<a class="el" href="mqtt_publish_function.html">MQTT_Publish</a> <br />
|
|
<a class="el" href="mqtt_ping_function.html">MQTT_Ping</a> <br />
|
|
<a class="el" href="mqtt_unsubscribe_function.html">MQTT_Unsubscribe</a> <br />
|
|
<a class="el" href="mqtt_disconnect_function.html">MQTT_Disconnect</a> <br />
|
|
<a class="el" href="mqtt_processloop_function.html">MQTT_ProcessLoop</a> <br />
|
|
<a class="el" href="mqtt_receiveloop_function.html">MQTT_ReceiveLoop</a> <br />
|
|
<a class="el" href="mqtt_getpacketid_function.html">MQTT_GetPacketId</a> <br />
|
|
<a class="el" href="mqtt_getsubackstatuscodes_function.html">MQTT_GetSubAckStatusCodes</a> <br />
|
|
<a class="el" href="mqtt_status_strerror_function.html">MQTT_Status_strerror</a> <br />
|
|
<a class="el" href="mqtt_publishtoresend_function.html">MQTT_PublishToResend</a> <br />
|
|
<br />
|
|
</td></tr>
|
|
<tr id="row_2_0_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_init_function.html" target="_self">MQTT_Init</a></td><td class="desc">Initialize an MQTT context. </td></tr>
|
|
<tr id="row_2_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_connect_function.html" target="_self">MQTT_Connect</a></td><td class="desc">Establish an MQTT session. </td></tr>
|
|
<tr id="row_2_2_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_subscribe_function.html" target="_self">MQTT_Subscribe</a></td><td class="desc">Sends MQTT SUBSCRIBE for the given list of topic filters to the broker. </td></tr>
|
|
<tr id="row_2_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_publish_function.html" target="_self">MQTT_Publish</a></td><td class="desc">Publishes a message to the given topic name. </td></tr>
|
|
<tr id="row_2_4_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_ping_function.html" target="_self">MQTT_Ping</a></td><td class="desc">Sends an MQTT PINGREQ to broker. </td></tr>
|
|
<tr id="row_2_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_unsubscribe_function.html" target="_self">MQTT_Unsubscribe</a></td><td class="desc">Sends MQTT UNSUBSCRIBE for the given list of topic filters to the broker. </td></tr>
|
|
<tr id="row_2_6_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_disconnect_function.html" target="_self">MQTT_Disconnect</a></td><td class="desc">Disconnect an MQTT session. </td></tr>
|
|
<tr id="row_2_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_processloop_function.html" target="_self">MQTT_ProcessLoop</a></td><td class="desc">Loop to receive packets from the transport interface. Handles keep alive. </td></tr>
|
|
<tr id="row_2_8_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_receiveloop_function.html" target="_self">MQTT_ReceiveLoop</a></td><td class="desc">Loop to receive packets from the transport interface. Does not handle keep alive. </td></tr>
|
|
<tr id="row_2_9_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_getpacketid_function.html" target="_self">MQTT_GetPacketId</a></td><td class="desc">Get a packet ID that is valid according to the MQTT 3.1.1 spec. </td></tr>
|
|
<tr id="row_2_10_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_getsubackstatuscodes_function.html" target="_self">MQTT_GetSubAckStatusCodes</a></td><td class="desc">Parses the payload of an MQTT SUBACK packet that contains status codes corresponding to topic filter subscription requests from the original subscribe packet. </td></tr>
|
|
<tr id="row_2_11_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_status_strerror_function.html" target="_self">MQTT_Status_strerror</a></td><td class="desc">Error code to string conversion for MQTT statuses. </td></tr>
|
|
<tr id="row_2_12_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_publishtoresend_function.html" target="_self">MQTT_PublishToResend</a></td><td class="desc">Get the packet ID of next pending publish to be resent. </td></tr>
|
|
<tr id="row_2_13_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_getconnectpacketsize_function.html" target="_self">MQTT_GetConnectPacketSize</a></td><td class="desc">Get the size and Remaining Length of an MQTT CONNECT packet. </td></tr>
|
|
<tr id="row_2_14_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_serializeconnect_function.html" target="_self">MQTT_SerializeConnect</a></td><td class="desc">Serialize an MQTT CONNECT packet in the given fixed buffer <code>pFixedBuffer</code>. </td></tr>
|
|
<tr id="row_2_15_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_getsubscribepacketsize_function.html" target="_self">MQTT_GetSubscribePacketSize</a></td><td class="desc">Get packet size and Remaining Length of an MQTT SUBSCRIBE packet. </td></tr>
|
|
<tr id="row_2_16_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_serializesubscribe_function.html" target="_self">MQTT_SerializeSubscribe</a></td><td class="desc">Serialize an MQTT SUBSCRIBE packet in the given buffer. </td></tr>
|
|
<tr id="row_2_17_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_getunsubscribepacketsize_function.html" target="_self">MQTT_GetUnsubscribePacketSize</a></td><td class="desc">Get packet size and Remaining Length of an MQTT UNSUBSCRIBE packet. </td></tr>
|
|
<tr id="row_2_18_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_serializeunsubscribe_function.html" target="_self">MQTT_SerializeUnsubscribe</a></td><td class="desc">Serialize an MQTT UNSUBSCRIBE packet in the given buffer. </td></tr>
|
|
<tr id="row_2_19_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_getpublishpacketsize_function.html" target="_self">MQTT_GetPublishPacketSize</a></td><td class="desc">Get the packet size and remaining length of an MQTT PUBLISH packet. </td></tr>
|
|
<tr id="row_2_20_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_serializepublish_function.html" target="_self">MQTT_SerializePublish</a></td><td class="desc">Serialize an MQTT PUBLISH packet in the given buffer. </td></tr>
|
|
<tr id="row_2_21_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_serializepublishheader_function.html" target="_self">MQTT_SerializePublishHeader</a></td><td class="desc">Serialize an MQTT PUBLISH packet header in the given buffer. </td></tr>
|
|
<tr id="row_2_22_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_serializeack_function.html" target="_self">MQTT_SerializeAck</a></td><td class="desc">Serialize an MQTT PUBACK, PUBREC, PUBREL, or PUBCOMP into the given buffer. </td></tr>
|
|
<tr id="row_2_23_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_getdisconnectpacketsize_function.html" target="_self">MQTT_GetDisconnectPacketSize</a></td><td class="desc">Get the size of an MQTT DISCONNECT packet. </td></tr>
|
|
<tr id="row_2_24_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_serializedisconnect_function.html" target="_self">MQTT_SerializeDisconnect</a></td><td class="desc">Serialize an MQTT DISCONNECT packet into the given buffer. </td></tr>
|
|
<tr id="row_2_25_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_getpingreqpacketsize_function.html" target="_self">MQTT_GetPingreqPacketSize</a></td><td class="desc">Get the size of an MQTT PINGREQ packet. </td></tr>
|
|
<tr id="row_2_26_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_serializepingreq_function.html" target="_self">MQTT_SerializePingreq</a></td><td class="desc">Serialize an MQTT PINGREQ packet into the given buffer. </td></tr>
|
|
<tr id="row_2_27_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_deserializepublish_function.html" target="_self">MQTT_DeserializePublish</a></td><td class="desc">Deserialize an MQTT PUBLISH packet. </td></tr>
|
|
<tr id="row_2_28_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_deserializeack_function.html" target="_self">MQTT_DeserializeAck</a></td><td class="desc">Deserialize an MQTT CONNACK, SUBACK, UNSUBACK, PUBACK, PUBREC, PUBREL, PUBCOMP, or PINGRESP. </td></tr>
|
|
<tr id="row_2_29_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><a class="el" href="mqtt_getincomingpackettypeandlength_function.html" target="_self">MQTT_GetIncomingPacketTypeAndLength</a></td><td class="desc">Extract the MQTT packet type and length from incoming packet. </td></tr>
|
|
<tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="mqtt_porting.html" target="_self">Porting Guide</a></td><td class="desc">Guide for porting MQTT to a new platform </td></tr>
|
|
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="mqtt_timeouts.html" target="_self">Timeouts in coreMQTT library</a></td><td class="desc">Information about timeouts that coreMQTT library relies on </td></tr>
|
|
<tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="mqtt_transport_interface.html" target="_self">Transport Interface</a></td><td class="desc">The transport interface definition </td></tr>
|
|
</table>
|
|
</div><!-- directory -->
|
|
</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.2 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|