Doxygen for afe000c

main/core__mqtt__state_8c.html

@@ -1313,9 +1313,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#a44b3cf50dc477a9f97413a92
 <div class="line">         <span class="comment">// list of outgoing publishes.</span></div>
 <div class="line">     }</div>
 <div class="line">}</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:2805</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:2679</div></div>
-<div class="ttc" id="acore__mqtt__state_8h_html_a44b3cf50dc477a9f97413a9238a961f6"><div class="ttname"><a href="core__mqtt__state_8h.html#a44b3cf50dc477a9f97413a9238a961f6">MQTT_PublishToResend</a></div><div class="ttdeci">uint16_t MQTT_PublishToResend(const MQTTContext_t *pMqttContext, MQTTStateCursor_t *pCursor)</div><div class="ttdoc">Get the packet ID of next pending publish to be resent.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.c:1123</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:2797</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:2671</div></div>
+<div class="ttc" id="acore__mqtt__state_8h_html_a44b3cf50dc477a9f97413a9238a961f6"><div class="ttname"><a href="core__mqtt__state_8h.html#a44b3cf50dc477a9f97413a9238a961f6">MQTT_PublishToResend</a></div><div class="ttdeci">uint16_t MQTT_PublishToResend(const MQTTContext_t *pMqttContext, MQTTStateCursor_t *pCursor)</div><div class="ttdoc">Get the packet ID of next pending publish to be resent.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.c:1117</div></div>
 <div class="ttc" id="agroup__mqtt__basic__types_html_ga2ca7d486d83fe555953a8c7876ee0d6e"><div class="ttname"><a href="group__mqtt__basic__types.html#ga2ca7d486d83fe555953a8c7876ee0d6e">MQTTStateCursor_t</a></div><div class="ttdeci">size_t MQTTStateCursor_t</div><div class="ttdoc">Cursor for iterating through state records.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.h:51</div></div>
 <div class="ttc" id="agroup__mqtt__constants_html_ga666ad78e7eaaffa51f5cab96201a9476"><div class="ttname"><a href="group__mqtt__constants.html#ga666ad78e7eaaffa51f5cab96201a9476">MQTT_STATE_CURSOR_INITIALIZER</a></div><div class="ttdeci">#define MQTT_STATE_CURSOR_INITIALIZER</div><div class="ttdoc">Initializer value for an MQTTStateCursor_t, indicating a search should start at the beginning of a st...</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.h:45</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:87</div></div>

main/core__mqtt__state_8h.html

@@ -219,9 +219,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#a44b3cf50dc477a9f97413a92
 <div class="line">         <span class="comment">// list of outgoing publishes.</span></div>
 <div class="line">     }</div>
 <div class="line">}</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:2805</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:2679</div></div>
-<div class="ttc" id="acore__mqtt__state_8h_html_a44b3cf50dc477a9f97413a9238a961f6"><div class="ttname"><a href="core__mqtt__state_8h.html#a44b3cf50dc477a9f97413a9238a961f6">MQTT_PublishToResend</a></div><div class="ttdeci">uint16_t MQTT_PublishToResend(const MQTTContext_t *pMqttContext, MQTTStateCursor_t *pCursor)</div><div class="ttdoc">Get the packet ID of next pending publish to be resent.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.c:1123</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:2797</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:2671</div></div>
+<div class="ttc" id="acore__mqtt__state_8h_html_a44b3cf50dc477a9f97413a9238a961f6"><div class="ttname"><a href="core__mqtt__state_8h.html#a44b3cf50dc477a9f97413a9238a961f6">MQTT_PublishToResend</a></div><div class="ttdeci">uint16_t MQTT_PublishToResend(const MQTTContext_t *pMqttContext, MQTTStateCursor_t *pCursor)</div><div class="ttdoc">Get the packet ID of next pending publish to be resent.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.c:1117</div></div>
 <div class="ttc" id="agroup__mqtt__basic__types_html_ga2ca7d486d83fe555953a8c7876ee0d6e"><div class="ttname"><a href="group__mqtt__basic__types.html#ga2ca7d486d83fe555953a8c7876ee0d6e">MQTTStateCursor_t</a></div><div class="ttdeci">size_t MQTTStateCursor_t</div><div class="ttdoc">Cursor for iterating through state records.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.h:51</div></div>
 <div class="ttc" id="agroup__mqtt__constants_html_ga666ad78e7eaaffa51f5cab96201a9476"><div class="ttname"><a href="group__mqtt__constants.html#ga666ad78e7eaaffa51f5cab96201a9476">MQTT_STATE_CURSOR_INITIALIZER</a></div><div class="ttdeci">#define MQTT_STATE_CURSOR_INITIALIZER</div><div class="ttdoc">Initializer value for an MQTTStateCursor_t, indicating a search should start at the beginning of a st...</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.h:45</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:87</div></div>

main/core__mqtt__state_8h_source.html

@@ -181,15 +181,15 @@
 <div class="line"><a id="l00309" name="l00309"></a><span class="lineno">  309</span> </div>
 <div class="line"><a id="l00310" name="l00310"></a><span class="lineno">  310</span><span class="preprocessor">#endif </span><span class="comment">/* ifndef CORE_MQTT_STATE_H */</span><span class="preprocessor"></span></div>
 <div class="ttc" id="acore__mqtt_8h_html"><div class="ttname"><a href="core__mqtt_8h.html">core_mqtt.h</a></div><div class="ttdoc">User-facing functions of the MQTT 3.1.1 library.</div></div>
-<div class="ttc" id="acore__mqtt__state_8c_html_a09a013b709085ffd51faa33c067cce1f"><div class="ttname"><a href="core__mqtt__state_8c.html#a09a013b709085ffd51faa33c067cce1f">MQTT_UpdateStateAck</a></div><div class="ttdeci">MQTTStatus_t MQTT_UpdateStateAck(const MQTTContext_t *pMqttContext, uint16_t packetId, MQTTPubAckType_t packetType, MQTTStateOperation_t opType, MQTTPublishState_t *pNewState)</div><div class="ttdoc">Update the state record for an ACKed publish.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.c:1005</div></div>
-<div class="ttc" id="acore__mqtt__state_8c_html_a0cad28e34f03b84aff43ee243ce8e2cf"><div class="ttname"><a href="core__mqtt__state_8c.html#a0cad28e34f03b84aff43ee243ce8e2cf">MQTT_CalculateStateAck</a></div><div class="ttdeci">MQTTPublishState_t MQTT_CalculateStateAck(MQTTPubAckType_t packetType, MQTTStateOperation_t opType, MQTTQoS_t qos)</div><div class="ttdoc">Calculate the state from a PUBACK, PUBREC, PUBREL, or PUBCOMP.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.c:657</div></div>
-<div class="ttc" id="acore__mqtt__state_8c_html_a43bc5d82716e1d8b6e167ec0fe50de5d"><div class="ttname"><a href="core__mqtt__state_8c.html#a43bc5d82716e1d8b6e167ec0fe50de5d">MQTT_ReserveState</a></div><div class="ttdeci">MQTTStatus_t MQTT_ReserveState(const MQTTContext_t *pMqttContext, uint16_t packetId, MQTTQoS_t qos)</div><div class="ttdoc">Reserve an entry for an outgoing QoS 1 or Qos 2 publish.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.c:825</div></div>
-<div class="ttc" id="acore__mqtt__state_8c_html_a53d786203ca4d5d5630a9eb3dd4cddae"><div class="ttname"><a href="core__mqtt__state_8c.html#a53d786203ca4d5d5630a9eb3dd4cddae">MQTT_State_strerror</a></div><div class="ttdeci">const char * MQTT_State_strerror(MQTTPublishState_t state)</div><div class="ttdoc">State to string conversion for state engine.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.c:1153</div></div>
-<div class="ttc" id="acore__mqtt__state_8c_html_aadc4fdd8af74ac25b848a33e916bff50"><div class="ttname"><a href="core__mqtt__state_8c.html#aadc4fdd8af74ac25b848a33e916bff50">MQTT_CalculateStatePublish</a></div><div class="ttdeci">MQTTPublishState_t MQTT_CalculateStatePublish(MQTTStateOperation_t opType, MQTTQoS_t qos)</div><div class="ttdoc">Calculate the new state for a publish from its qos and operation type.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.c:854</div></div>
-<div class="ttc" id="acore__mqtt__state_8c_html_ad657bd67745c66bc50f0441b4cc94763"><div class="ttname"><a href="core__mqtt__state_8c.html#ad657bd67745c66bc50f0441b4cc94763">MQTT_UpdateStatePublish</a></div><div class="ttdeci">MQTTStatus_t MQTT_UpdateStatePublish(const MQTTContext_t *pMqttContext, uint16_t packetId, MQTTStateOperation_t opType, MQTTQoS_t qos, MQTTPublishState_t *pNewState)</div><div class="ttdoc">Update the state record for a PUBLISH packet.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.c:883</div></div>
-<div class="ttc" id="acore__mqtt__state_8c_html_ae58ade262ec01262687554b349b2fdf5"><div class="ttname"><a href="core__mqtt__state_8c.html#ae58ade262ec01262687554b349b2fdf5">MQTT_PubrelToResend</a></div><div class="ttdeci">uint16_t MQTT_PubrelToResend(const MQTTContext_t *pMqttContext, MQTTStateCursor_t *pCursor, MQTTPublishState_t *pState)</div><div class="ttdoc">Get the packet ID of next pending PUBREL ack to be resent.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.c:1087</div></div>
-<div class="ttc" id="acore__mqtt__state_8c_html_aef2c13cffbbd5c71183282e69ac9d799"><div class="ttname"><a href="core__mqtt__state_8c.html#aef2c13cffbbd5c71183282e69ac9d799">MQTT_RemoveStateRecord</a></div><div class="ttdeci">MQTTStatus_t MQTT_RemoveStateRecord(const MQTTContext_t *pMqttContext, uint16_t packetId)</div><div class="ttdoc">Remove the state record for a PUBLISH packet.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.c:957</div></div>
-<div class="ttc" id="acore__mqtt__state_8h_html_a44b3cf50dc477a9f97413a9238a961f6"><div class="ttname"><a href="core__mqtt__state_8h.html#a44b3cf50dc477a9f97413a9238a961f6">MQTT_PublishToResend</a></div><div class="ttdeci">uint16_t MQTT_PublishToResend(const MQTTContext_t *pMqttContext, MQTTStateCursor_t *pCursor)</div><div class="ttdoc">Get the packet ID of next pending publish to be resent.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.c:1123</div></div>
+<div class="ttc" id="acore__mqtt__state_8c_html_a09a013b709085ffd51faa33c067cce1f"><div class="ttname"><a href="core__mqtt__state_8c.html#a09a013b709085ffd51faa33c067cce1f">MQTT_UpdateStateAck</a></div><div class="ttdeci">MQTTStatus_t MQTT_UpdateStateAck(const MQTTContext_t *pMqttContext, uint16_t packetId, MQTTPubAckType_t packetType, MQTTStateOperation_t opType, MQTTPublishState_t *pNewState)</div><div class="ttdoc">Update the state record for an ACKed publish.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.c:999</div></div>
+<div class="ttc" id="acore__mqtt__state_8c_html_a0cad28e34f03b84aff43ee243ce8e2cf"><div class="ttname"><a href="core__mqtt__state_8c.html#a0cad28e34f03b84aff43ee243ce8e2cf">MQTT_CalculateStateAck</a></div><div class="ttdeci">MQTTPublishState_t MQTT_CalculateStateAck(MQTTPubAckType_t packetType, MQTTStateOperation_t opType, MQTTQoS_t qos)</div><div class="ttdoc">Calculate the state from a PUBACK, PUBREC, PUBREL, or PUBCOMP.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.c:651</div></div>
+<div class="ttc" id="acore__mqtt__state_8c_html_a43bc5d82716e1d8b6e167ec0fe50de5d"><div class="ttname"><a href="core__mqtt__state_8c.html#a43bc5d82716e1d8b6e167ec0fe50de5d">MQTT_ReserveState</a></div><div class="ttdeci">MQTTStatus_t MQTT_ReserveState(const MQTTContext_t *pMqttContext, uint16_t packetId, MQTTQoS_t qos)</div><div class="ttdoc">Reserve an entry for an outgoing QoS 1 or Qos 2 publish.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.c:819</div></div>
+<div class="ttc" id="acore__mqtt__state_8c_html_a53d786203ca4d5d5630a9eb3dd4cddae"><div class="ttname"><a href="core__mqtt__state_8c.html#a53d786203ca4d5d5630a9eb3dd4cddae">MQTT_State_strerror</a></div><div class="ttdeci">const char * MQTT_State_strerror(MQTTPublishState_t state)</div><div class="ttdoc">State to string conversion for state engine.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.c:1147</div></div>
+<div class="ttc" id="acore__mqtt__state_8c_html_aadc4fdd8af74ac25b848a33e916bff50"><div class="ttname"><a href="core__mqtt__state_8c.html#aadc4fdd8af74ac25b848a33e916bff50">MQTT_CalculateStatePublish</a></div><div class="ttdeci">MQTTPublishState_t MQTT_CalculateStatePublish(MQTTStateOperation_t opType, MQTTQoS_t qos)</div><div class="ttdoc">Calculate the new state for a publish from its qos and operation type.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.c:848</div></div>
+<div class="ttc" id="acore__mqtt__state_8c_html_ad657bd67745c66bc50f0441b4cc94763"><div class="ttname"><a href="core__mqtt__state_8c.html#ad657bd67745c66bc50f0441b4cc94763">MQTT_UpdateStatePublish</a></div><div class="ttdeci">MQTTStatus_t MQTT_UpdateStatePublish(const MQTTContext_t *pMqttContext, uint16_t packetId, MQTTStateOperation_t opType, MQTTQoS_t qos, MQTTPublishState_t *pNewState)</div><div class="ttdoc">Update the state record for a PUBLISH packet.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.c:877</div></div>
+<div class="ttc" id="acore__mqtt__state_8c_html_ae58ade262ec01262687554b349b2fdf5"><div class="ttname"><a href="core__mqtt__state_8c.html#ae58ade262ec01262687554b349b2fdf5">MQTT_PubrelToResend</a></div><div class="ttdeci">uint16_t MQTT_PubrelToResend(const MQTTContext_t *pMqttContext, MQTTStateCursor_t *pCursor, MQTTPublishState_t *pState)</div><div class="ttdoc">Get the packet ID of next pending PUBREL ack to be resent.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.c:1081</div></div>
+<div class="ttc" id="acore__mqtt__state_8c_html_aef2c13cffbbd5c71183282e69ac9d799"><div class="ttname"><a href="core__mqtt__state_8c.html#aef2c13cffbbd5c71183282e69ac9d799">MQTT_RemoveStateRecord</a></div><div class="ttdeci">MQTTStatus_t MQTT_RemoveStateRecord(const MQTTContext_t *pMqttContext, uint16_t packetId)</div><div class="ttdoc">Remove the state record for a PUBLISH packet.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.c:951</div></div>
+<div class="ttc" id="acore__mqtt__state_8h_html_a44b3cf50dc477a9f97413a9238a961f6"><div class="ttname"><a href="core__mqtt__state_8h.html#a44b3cf50dc477a9f97413a9238a961f6">MQTT_PublishToResend</a></div><div class="ttdeci">uint16_t MQTT_PublishToResend(const MQTTContext_t *pMqttContext, MQTTStateCursor_t *pCursor)</div><div class="ttdoc">Get the packet ID of next pending publish to be resent.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.c:1117</div></div>
 <div class="ttc" id="agroup__mqtt__basic__types_html_ga2ca7d486d83fe555953a8c7876ee0d6e"><div class="ttname"><a href="group__mqtt__basic__types.html#ga2ca7d486d83fe555953a8c7876ee0d6e">MQTTStateCursor_t</a></div><div class="ttdeci">size_t MQTTStateCursor_t</div><div class="ttdoc">Cursor for iterating through state records.</div><div class="ttdef"><b>Definition:</b> core_mqtt_state.h:51</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:119</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:138</div></div>