mirror of
https://github.com/FreeRTOS/coreMQTT
synced 2025-05-12 21:35:41 +08:00
213 lines
16 KiB
HTML
213 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" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.6"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>coreMQTT: Constants</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function() { init_search(); });
|
|
/* @license-end */
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="style.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">coreMQTT<span id="projectnumber"> v2.2.0</span>
|
|
</div>
|
|
<div id="projectbrief">MQTT 3.1.1 Client Library</div>
|
|
</td>
|
|
<td> <div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
|
|
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.6 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('group__mqtt__constants.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#define-members">Macros</a> </div>
|
|
<div class="headertitle"><div class="title">Constants</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Constants defined in the MQTT library.
|
|
<a href="#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:ga9fde6503edb9eaad50ecd3392ab9992a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mqtt__constants.html#ga9fde6503edb9eaad50ecd3392ab9992a">MQTT_PACKET_ID_INVALID</a>   ( ( uint16_t ) 0U )</td></tr>
|
|
<tr class="memdesc:ga9fde6503edb9eaad50ecd3392ab9992a"><td class="mdescLeft"> </td><td class="mdescRight">Invalid packet identifier. <br /></td></tr>
|
|
<tr class="separator:ga9fde6503edb9eaad50ecd3392ab9992a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga928ea0bff12ebf9cf9fa9dfe5cafebbb"><td class="memItemLeft" align="right" valign="top"><a id="ga928ea0bff12ebf9cf9fa9dfe5cafebbb" name="ga928ea0bff12ebf9cf9fa9dfe5cafebbb"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>MQTT_SUB_UNSUB_MAX_VECTORS</b>   ( 4U )</td></tr>
|
|
<tr class="memdesc:ga928ea0bff12ebf9cf9fa9dfe5cafebbb"><td class="mdescLeft"> </td><td class="mdescRight">Maximum number of vectors in subscribe and unsubscribe packet. <br /></td></tr>
|
|
<tr class="separator:ga928ea0bff12ebf9cf9fa9dfe5cafebbb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga64a0515bda2ecc89e97595535e1cf0ef"><td class="memItemLeft" align="right" valign="top"><a id="ga64a0515bda2ecc89e97595535e1cf0ef" name="ga64a0515bda2ecc89e97595535e1cf0ef"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>MQTT_PACKET_TYPE_CONNECT</b>   ( ( uint8_t ) 0x10U )</td></tr>
|
|
<tr class="memdesc:ga64a0515bda2ecc89e97595535e1cf0ef"><td class="mdescLeft"> </td><td class="mdescRight">CONNECT (client-to-server). <br /></td></tr>
|
|
<tr class="separator:ga64a0515bda2ecc89e97595535e1cf0ef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab14f6c39c303eac1a76816edfde7feab"><td class="memItemLeft" align="right" valign="top"><a id="gab14f6c39c303eac1a76816edfde7feab" name="gab14f6c39c303eac1a76816edfde7feab"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>MQTT_PACKET_TYPE_CONNACK</b>   ( ( uint8_t ) 0x20U )</td></tr>
|
|
<tr class="memdesc:gab14f6c39c303eac1a76816edfde7feab"><td class="mdescLeft"> </td><td class="mdescRight">CONNACK (server-to-client). <br /></td></tr>
|
|
<tr class="separator:gab14f6c39c303eac1a76816edfde7feab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5b2d79c61f2591c8e5772f974826d4ad"><td class="memItemLeft" align="right" valign="top"><a id="ga5b2d79c61f2591c8e5772f974826d4ad" name="ga5b2d79c61f2591c8e5772f974826d4ad"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>MQTT_PACKET_TYPE_PUBLISH</b>   ( ( uint8_t ) 0x30U )</td></tr>
|
|
<tr class="memdesc:ga5b2d79c61f2591c8e5772f974826d4ad"><td class="mdescLeft"> </td><td class="mdescRight">PUBLISH (bidirectional). <br /></td></tr>
|
|
<tr class="separator:ga5b2d79c61f2591c8e5772f974826d4ad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5f279d63de47a973b41b95f74f47a4f6"><td class="memItemLeft" align="right" valign="top"><a id="ga5f279d63de47a973b41b95f74f47a4f6" name="ga5f279d63de47a973b41b95f74f47a4f6"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>MQTT_PACKET_TYPE_PUBACK</b>   ( ( uint8_t ) 0x40U )</td></tr>
|
|
<tr class="memdesc:ga5f279d63de47a973b41b95f74f47a4f6"><td class="mdescLeft"> </td><td class="mdescRight">PUBACK (bidirectional). <br /></td></tr>
|
|
<tr class="separator:ga5f279d63de47a973b41b95f74f47a4f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gafa2d8f28da39560f152076b99610e6a3"><td class="memItemLeft" align="right" valign="top"><a id="gafa2d8f28da39560f152076b99610e6a3" name="gafa2d8f28da39560f152076b99610e6a3"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>MQTT_PACKET_TYPE_PUBREC</b>   ( ( uint8_t ) 0x50U )</td></tr>
|
|
<tr class="memdesc:gafa2d8f28da39560f152076b99610e6a3"><td class="mdescLeft"> </td><td class="mdescRight">PUBREC (bidirectional). <br /></td></tr>
|
|
<tr class="separator:gafa2d8f28da39560f152076b99610e6a3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaeaa2ceecffda50e2d22ccecf046083c6"><td class="memItemLeft" align="right" valign="top"><a id="gaeaa2ceecffda50e2d22ccecf046083c6" name="gaeaa2ceecffda50e2d22ccecf046083c6"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>MQTT_PACKET_TYPE_PUBREL</b>   ( ( uint8_t ) 0x62U )</td></tr>
|
|
<tr class="memdesc:gaeaa2ceecffda50e2d22ccecf046083c6"><td class="mdescLeft"> </td><td class="mdescRight">PUBREL (bidirectional). <br /></td></tr>
|
|
<tr class="separator:gaeaa2ceecffda50e2d22ccecf046083c6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga478ecbc98d2ca83d4ce7db33622b5c3b"><td class="memItemLeft" align="right" valign="top"><a id="ga478ecbc98d2ca83d4ce7db33622b5c3b" name="ga478ecbc98d2ca83d4ce7db33622b5c3b"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>MQTT_PACKET_TYPE_PUBCOMP</b>   ( ( uint8_t ) 0x70U )</td></tr>
|
|
<tr class="memdesc:ga478ecbc98d2ca83d4ce7db33622b5c3b"><td class="mdescLeft"> </td><td class="mdescRight">PUBCOMP (bidirectional). <br /></td></tr>
|
|
<tr class="separator:ga478ecbc98d2ca83d4ce7db33622b5c3b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga80cfef333e60d967ca927b2e5e665f18"><td class="memItemLeft" align="right" valign="top"><a id="ga80cfef333e60d967ca927b2e5e665f18" name="ga80cfef333e60d967ca927b2e5e665f18"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>MQTT_PACKET_TYPE_SUBSCRIBE</b>   ( ( uint8_t ) 0x82U )</td></tr>
|
|
<tr class="memdesc:ga80cfef333e60d967ca927b2e5e665f18"><td class="mdescLeft"> </td><td class="mdescRight">SUBSCRIBE (client-to-server). <br /></td></tr>
|
|
<tr class="separator:ga80cfef333e60d967ca927b2e5e665f18"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga307e0186aa17fdd0d6d181d3d2715766"><td class="memItemLeft" align="right" valign="top"><a id="ga307e0186aa17fdd0d6d181d3d2715766" name="ga307e0186aa17fdd0d6d181d3d2715766"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>MQTT_PACKET_TYPE_SUBACK</b>   ( ( uint8_t ) 0x90U )</td></tr>
|
|
<tr class="memdesc:ga307e0186aa17fdd0d6d181d3d2715766"><td class="mdescLeft"> </td><td class="mdescRight">SUBACK (server-to-client). <br /></td></tr>
|
|
<tr class="separator:ga307e0186aa17fdd0d6d181d3d2715766"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4a94c954cfcea31c8fc3e2adf092b228"><td class="memItemLeft" align="right" valign="top"><a id="ga4a94c954cfcea31c8fc3e2adf092b228" name="ga4a94c954cfcea31c8fc3e2adf092b228"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>MQTT_PACKET_TYPE_UNSUBSCRIBE</b>   ( ( uint8_t ) 0xA2U )</td></tr>
|
|
<tr class="memdesc:ga4a94c954cfcea31c8fc3e2adf092b228"><td class="mdescLeft"> </td><td class="mdescRight">UNSUBSCRIBE (client-to-server). <br /></td></tr>
|
|
<tr class="separator:ga4a94c954cfcea31c8fc3e2adf092b228"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga38bc8ed0b9a1581cf85cecdede7d1a64"><td class="memItemLeft" align="right" valign="top"><a id="ga38bc8ed0b9a1581cf85cecdede7d1a64" name="ga38bc8ed0b9a1581cf85cecdede7d1a64"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>MQTT_PACKET_TYPE_UNSUBACK</b>   ( ( uint8_t ) 0xB0U )</td></tr>
|
|
<tr class="memdesc:ga38bc8ed0b9a1581cf85cecdede7d1a64"><td class="mdescLeft"> </td><td class="mdescRight">UNSUBACK (server-to-client). <br /></td></tr>
|
|
<tr class="separator:ga38bc8ed0b9a1581cf85cecdede7d1a64"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gacbe28c7d081275d1805c2142ff792185"><td class="memItemLeft" align="right" valign="top"><a id="gacbe28c7d081275d1805c2142ff792185" name="gacbe28c7d081275d1805c2142ff792185"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>MQTT_PACKET_TYPE_PINGREQ</b>   ( ( uint8_t ) 0xC0U )</td></tr>
|
|
<tr class="memdesc:gacbe28c7d081275d1805c2142ff792185"><td class="mdescLeft"> </td><td class="mdescRight">PINGREQ (client-to-server). <br /></td></tr>
|
|
<tr class="separator:gacbe28c7d081275d1805c2142ff792185"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga285fc02048e2482794042fa98639e514"><td class="memItemLeft" align="right" valign="top"><a id="ga285fc02048e2482794042fa98639e514" name="ga285fc02048e2482794042fa98639e514"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>MQTT_PACKET_TYPE_PINGRESP</b>   ( ( uint8_t ) 0xD0U )</td></tr>
|
|
<tr class="memdesc:ga285fc02048e2482794042fa98639e514"><td class="mdescLeft"> </td><td class="mdescRight">PINGRESP (server-to-client). <br /></td></tr>
|
|
<tr class="separator:ga285fc02048e2482794042fa98639e514"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaed07155a3d6fa4b7624b9f36ed33ec6d"><td class="memItemLeft" align="right" valign="top"><a id="gaed07155a3d6fa4b7624b9f36ed33ec6d" name="gaed07155a3d6fa4b7624b9f36ed33ec6d"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>MQTT_PACKET_TYPE_DISCONNECT</b>   ( ( uint8_t ) 0xE0U )</td></tr>
|
|
<tr class="memdesc:gaed07155a3d6fa4b7624b9f36ed33ec6d"><td class="mdescLeft"> </td><td class="mdescRight">DISCONNECT (client-to-server). <br /></td></tr>
|
|
<tr class="separator:gaed07155a3d6fa4b7624b9f36ed33ec6d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga26994fcfacb1cff892caa45ec31ca7c6"><td class="memItemLeft" align="right" valign="top"><a id="ga26994fcfacb1cff892caa45ec31ca7c6" name="ga26994fcfacb1cff892caa45ec31ca7c6"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>MQTT_PUBLISH_ACK_PACKET_SIZE</b>   ( 4UL )</td></tr>
|
|
<tr class="memdesc:ga26994fcfacb1cff892caa45ec31ca7c6"><td class="mdescLeft"> </td><td class="mdescRight">The size of MQTT PUBACK, PUBREC, PUBREL, and PUBCOMP packets, per MQTT spec. <br /></td></tr>
|
|
<tr class="separator:ga26994fcfacb1cff892caa45ec31ca7c6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga666ad78e7eaaffa51f5cab96201a9476"><td class="memItemLeft" align="right" valign="top"><a id="ga666ad78e7eaaffa51f5cab96201a9476" name="ga666ad78e7eaaffa51f5cab96201a9476"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>MQTT_STATE_CURSOR_INITIALIZER</b>   ( ( size_t ) 0 )</td></tr>
|
|
<tr class="memdesc:ga666ad78e7eaaffa51f5cab96201a9476"><td class="mdescLeft"> </td><td class="mdescRight">Initializer value for an <a class="el" href="group__mqtt__basic__types.html#ga2ca7d486d83fe555953a8c7876ee0d6e" title="Cursor for iterating through state records.">MQTTStateCursor_t</a>, indicating a search should start at the beginning of a state record array. <br /></td></tr>
|
|
<tr class="separator:ga666ad78e7eaaffa51f5cab96201a9476"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>Constants defined in the MQTT library. </p>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="ga9fde6503edb9eaad50ecd3392ab9992a" name="ga9fde6503edb9eaad50ecd3392ab9992a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9fde6503edb9eaad50ecd3392ab9992a">◆ </a></span>MQTT_PACKET_ID_INVALID</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MQTT_PACKET_ID_INVALID   ( ( uint16_t ) 0U )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Invalid packet identifier. </p>
|
|
<p>Zero is an invalid packet identifier as per MQTT v3.1.1 spec. </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|