Doxygen for 8314c29

main/core__mqtt__agent_8c.html

@@ -1115,7 +1115,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a584863528e72229f35003485
 <div class="line">   <span class="comment">// fixedBuffer structs were copied into the context, so the original structs</span></div>
 <div class="line">   <span class="comment">// do not need to stay in scope.</span></div>
 <div class="line">}</div>
-<div class="ttc" id="acore__mqtt__agent_8h_html_a584863528e72229f35003485f7ee0edd"><div class="ttname"><a href="core__mqtt__agent_8h.html#a584863528e72229f35003485f7ee0edd">MQTTAgent_Init</a></div><div class="ttdeci">MQTTStatus_t MQTTAgent_Init(MQTTAgentContext_t *pMqttAgentContext, const MQTTAgentMessageInterface_t *pMsgInterface, const MQTTFixedBuffer_t *pNetworkBuffer, const TransportInterface_t *pTransportInterface, MQTTGetCurrentTimeFunc_t getCurrentTimeMs, MQTTAgentIncomingPublishCallback_t incomingCallback, void *pIncomingPacketContext)</div><div class="ttdoc">Perform any initialization the MQTT agent requires before it can be used. Must be called before any o...</div><div class="ttdef"><b>Definition:</b> core_mqtt_agent.c:980</div></div>
+<div class="ttc" id="acore__mqtt__agent_8h_html_a584863528e72229f35003485f7ee0edd"><div class="ttname"><a href="core__mqtt__agent_8h.html#a584863528e72229f35003485f7ee0edd">MQTTAgent_Init</a></div><div class="ttdeci">MQTTStatus_t MQTTAgent_Init(MQTTAgentContext_t *pMqttAgentContext, const MQTTAgentMessageInterface_t *pMsgInterface, const MQTTFixedBuffer_t *pNetworkBuffer, const TransportInterface_t *pTransportInterface, MQTTGetCurrentTimeFunc_t getCurrentTimeMs, MQTTAgentIncomingPublishCallback_t incomingCallback, void *pIncomingPacketContext)</div><div class="ttdoc">Perform any initialization the MQTT agent requires before it can be used. Must be called before any o...</div><div class="ttdef"><b>Definition:</b> core_mqtt_agent.c:968</div></div>
 <div class="ttc" id="agroup__mqtt__agent__struct__types_html_ga3c47f2ebcec2e1150e40d039639e5a3b"><div class="ttname"><a href="group__mqtt__agent__struct__types.html#ga3c47f2ebcec2e1150e40d039639e5a3b">MQTTAgentMessageContext_t</a></div><div class="ttdeci">struct MQTTAgentMessageContext MQTTAgentMessageContext_t</div><div class="ttdoc">Context with which tasks may deliver messages to the agent.</div><div class="ttdef"><b>Definition:</b> core_mqtt_agent_message_interface.h:54</div></div>
 <div class="ttc" id="agroup__mqtt__enum__types_html_gaba7ec045874a1c3432f99173367f735c"><div class="ttname"><a href="coreMQTT/group__mqtt__enum__types.html#gaba7ec045874a1c3432f99173367f735c">MQTTStatus_t</a></div><div class="ttdeci">MQTTStatus_t</div></div>
 <div class="ttc" id="agroup__mqtt__struct__types_html_ga7769e434e7811caed8cd6fd7f9ec26ec"><div class="ttname"><a href="coreMQTT/group__mqtt__struct__types.html#ga7769e434e7811caed8cd6fd7f9ec26ec">NetworkContext_t</a></div><div class="ttdeci">struct NetworkContext NetworkContext_t</div></div>
@@ -1134,7 +1134,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#a584863528e72229f35003485
 <div class="ttc" id="astruct_transport_interface__t_html_a01cd9935e9a5266ca196243a0054d489"><div class="ttname"><a href="coreMQTT/struct_transport_interface__t.html#a01cd9935e9a5266ca196243a0054d489">TransportInterface_t::send</a></div><div class="ttdeci">TransportSend_t send</div></div>
 <div class="ttc" id="astruct_transport_interface__t_html_a7c34e9b865e2a509306f09c7dfa3699e"><div class="ttname"><a href="coreMQTT/struct_transport_interface__t.html#a7c34e9b865e2a509306f09c7dfa3699e">TransportInterface_t::recv</a></div><div class="ttdeci">TransportRecv_t recv</div></div>
 <div class="ttc" id="astruct_transport_interface__t_html_aaf4702050bef8d62714a4d3900e95087"><div class="ttname"><a href="coreMQTT/struct_transport_interface__t.html#aaf4702050bef8d62714a4d3900e95087">TransportInterface_t::pNetworkContext</a></div><div class="ttdeci">NetworkContext_t * pNetworkContext</div></div>
-</div><!-- fragment --> 
+</div><!-- fragment --> <p>Array used to maintain the outgoing publish records and their state by the coreMQTT library.</p>
+<p>Array used to maintain the outgoing publish records and their state by the coreMQTT library.</p>
+
 </div>
 </div>
 <a id="a9dafeb1701b1a0ee897b626a09cfcff7" name="a9dafeb1701b1a0ee897b626a09cfcff7"></a>

main/core__mqtt__agent_8h.html

@@ -348,7 +348,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a584863528e72229f35003485
 <div class="line">   <span class="comment">// fixedBuffer structs were copied into the context, so the original structs</span></div>
 <div class="line">   <span class="comment">// do not need to stay in scope.</span></div>
 <div class="line">}</div>
-<div class="ttc" id="acore__mqtt__agent_8h_html_a584863528e72229f35003485f7ee0edd"><div class="ttname"><a href="core__mqtt__agent_8h.html#a584863528e72229f35003485f7ee0edd">MQTTAgent_Init</a></div><div class="ttdeci">MQTTStatus_t MQTTAgent_Init(MQTTAgentContext_t *pMqttAgentContext, const MQTTAgentMessageInterface_t *pMsgInterface, const MQTTFixedBuffer_t *pNetworkBuffer, const TransportInterface_t *pTransportInterface, MQTTGetCurrentTimeFunc_t getCurrentTimeMs, MQTTAgentIncomingPublishCallback_t incomingCallback, void *pIncomingPacketContext)</div><div class="ttdoc">Perform any initialization the MQTT agent requires before it can be used. Must be called before any o...</div><div class="ttdef"><b>Definition:</b> core_mqtt_agent.c:980</div></div>
+<div class="ttc" id="acore__mqtt__agent_8h_html_a584863528e72229f35003485f7ee0edd"><div class="ttname"><a href="core__mqtt__agent_8h.html#a584863528e72229f35003485f7ee0edd">MQTTAgent_Init</a></div><div class="ttdeci">MQTTStatus_t MQTTAgent_Init(MQTTAgentContext_t *pMqttAgentContext, const MQTTAgentMessageInterface_t *pMsgInterface, const MQTTFixedBuffer_t *pNetworkBuffer, const TransportInterface_t *pTransportInterface, MQTTGetCurrentTimeFunc_t getCurrentTimeMs, MQTTAgentIncomingPublishCallback_t incomingCallback, void *pIncomingPacketContext)</div><div class="ttdoc">Perform any initialization the MQTT agent requires before it can be used. Must be called before any o...</div><div class="ttdef"><b>Definition:</b> core_mqtt_agent.c:968</div></div>
 <div class="ttc" id="agroup__mqtt__agent__struct__types_html_ga3c47f2ebcec2e1150e40d039639e5a3b"><div class="ttname"><a href="group__mqtt__agent__struct__types.html#ga3c47f2ebcec2e1150e40d039639e5a3b">MQTTAgentMessageContext_t</a></div><div class="ttdeci">struct MQTTAgentMessageContext MQTTAgentMessageContext_t</div><div class="ttdoc">Context with which tasks may deliver messages to the agent.</div><div class="ttdef"><b>Definition:</b> core_mqtt_agent_message_interface.h:54</div></div>
 <div class="ttc" id="agroup__mqtt__enum__types_html_gaba7ec045874a1c3432f99173367f735c"><div class="ttname"><a href="coreMQTT/group__mqtt__enum__types.html#gaba7ec045874a1c3432f99173367f735c">MQTTStatus_t</a></div><div class="ttdeci">MQTTStatus_t</div></div>
 <div class="ttc" id="agroup__mqtt__struct__types_html_ga7769e434e7811caed8cd6fd7f9ec26ec"><div class="ttname"><a href="coreMQTT/group__mqtt__struct__types.html#ga7769e434e7811caed8cd6fd7f9ec26ec">NetworkContext_t</a></div><div class="ttdeci">struct NetworkContext NetworkContext_t</div></div>
@@ -367,7 +367,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#a584863528e72229f35003485
 <div class="ttc" id="astruct_transport_interface__t_html_a01cd9935e9a5266ca196243a0054d489"><div class="ttname"><a href="coreMQTT/struct_transport_interface__t.html#a01cd9935e9a5266ca196243a0054d489">TransportInterface_t::send</a></div><div class="ttdeci">TransportSend_t send</div></div>
 <div class="ttc" id="astruct_transport_interface__t_html_a7c34e9b865e2a509306f09c7dfa3699e"><div class="ttname"><a href="coreMQTT/struct_transport_interface__t.html#a7c34e9b865e2a509306f09c7dfa3699e">TransportInterface_t::recv</a></div><div class="ttdeci">TransportRecv_t recv</div></div>
 <div class="ttc" id="astruct_transport_interface__t_html_aaf4702050bef8d62714a4d3900e95087"><div class="ttname"><a href="coreMQTT/struct_transport_interface__t.html#aaf4702050bef8d62714a4d3900e95087">TransportInterface_t::pNetworkContext</a></div><div class="ttdeci">NetworkContext_t * pNetworkContext</div></div>
-</div><!-- fragment --> 
+</div><!-- fragment --> <p>Array used to maintain the outgoing publish records and their state by the coreMQTT library.</p>
+<p>Array used to maintain the outgoing publish records and their state by the coreMQTT library.</p>
+
 </div>
 </div>
 <a id="a9dafeb1701b1a0ee897b626a09cfcff7" name="a9dafeb1701b1a0ee897b626a09cfcff7"></a>

main/core__mqtt__agent_8h_source.html

@@ -296,7 +296,7 @@
 <div class="ttc" id="acore__mqtt_8h_html"><div class="ttname"><a href="coreMQTT/core__mqtt_8h.html">core_mqtt.h</a></div></div>
 <div class="ttc" id="acore__mqtt__agent_8h_html_a0362d7d3d68628413f01b32ec2ff4ab6"><div class="ttname"><a href="core__mqtt__agent_8h.html#a0362d7d3d68628413f01b32ec2ff4ab6">MQTTAgent_CancelAll</a></div><div class="ttdeci">MQTTStatus_t MQTTAgent_CancelAll(MQTTAgentContext_t *pMqttAgentContext)</div><div class="ttdoc">Cancel all enqueued commands and those awaiting acknowledgment while the command loop is not running.</div><div class="ttdef"><b>Definition:</b> core_mqtt_agent.c:1128</div></div>
 <div class="ttc" id="acore__mqtt__agent_8h_html_a26687b9b762b5f52b14387bacdf17224"><div class="ttname"><a href="core__mqtt__agent_8h.html#a26687b9b762b5f52b14387bacdf17224">MQTTAgent_Disconnect</a></div><div class="ttdeci">MQTTStatus_t MQTTAgent_Disconnect(const MQTTAgentContext_t *pMqttAgentContext, const MQTTAgentCommandInfo_t *pCommandInfo)</div><div class="ttdoc">Add a command to disconnect an MQTT connection.</div><div class="ttdef"><b>Definition:</b> core_mqtt_agent.c:1300</div></div>
-<div class="ttc" id="acore__mqtt__agent_8h_html_a584863528e72229f35003485f7ee0edd"><div class="ttname"><a href="core__mqtt__agent_8h.html#a584863528e72229f35003485f7ee0edd">MQTTAgent_Init</a></div><div class="ttdeci">MQTTStatus_t MQTTAgent_Init(MQTTAgentContext_t *pMqttAgentContext, const MQTTAgentMessageInterface_t *pMsgInterface, const MQTTFixedBuffer_t *pNetworkBuffer, const TransportInterface_t *pTransportInterface, MQTTGetCurrentTimeFunc_t getCurrentTimeMs, MQTTAgentIncomingPublishCallback_t incomingCallback, void *pIncomingPacketContext)</div><div class="ttdoc">Perform any initialization the MQTT agent requires before it can be used. Must be called before any o...</div><div class="ttdef"><b>Definition:</b> core_mqtt_agent.c:980</div></div>
+<div class="ttc" id="acore__mqtt__agent_8h_html_a584863528e72229f35003485f7ee0edd"><div class="ttname"><a href="core__mqtt__agent_8h.html#a584863528e72229f35003485f7ee0edd">MQTTAgent_Init</a></div><div class="ttdeci">MQTTStatus_t MQTTAgent_Init(MQTTAgentContext_t *pMqttAgentContext, const MQTTAgentMessageInterface_t *pMsgInterface, const MQTTFixedBuffer_t *pNetworkBuffer, const TransportInterface_t *pTransportInterface, MQTTGetCurrentTimeFunc_t getCurrentTimeMs, MQTTAgentIncomingPublishCallback_t incomingCallback, void *pIncomingPacketContext)</div><div class="ttdoc">Perform any initialization the MQTT agent requires before it can be used. Must be called before any o...</div><div class="ttdef"><b>Definition:</b> core_mqtt_agent.c:968</div></div>
 <div class="ttc" id="acore__mqtt__agent_8h_html_a651cf10182392ecea5e8609af8855d49"><div class="ttname"><a href="core__mqtt__agent_8h.html#a651cf10182392ecea5e8609af8855d49">MQTTAgent_Subscribe</a></div><div class="ttdeci">MQTTStatus_t MQTTAgent_Subscribe(const MQTTAgentContext_t *pMqttAgentContext, MQTTAgentSubscribeArgs_t *pSubscriptionArgs, const MQTTAgentCommandInfo_t *pCommandInfo)</div><div class="ttdoc">Add a command to call MQTT_Subscribe() for an MQTT connection.</div><div class="ttdef"><b>Definition:</b> core_mqtt_agent.c:1177</div></div>
 <div class="ttc" id="acore__mqtt__agent_8h_html_a75065d6bff5f2d32831f2c74922296fb"><div class="ttname"><a href="core__mqtt__agent_8h.html#a75065d6bff5f2d32831f2c74922296fb">MQTTAgent_ResumeSession</a></div><div class="ttdeci">MQTTStatus_t MQTTAgent_ResumeSession(MQTTAgentContext_t *pMqttAgentContext, bool sessionPresent)</div><div class="ttdoc">Resume a session by resending publishes if a session is present in the broker, or clear state informa...</div><div class="ttdef"><b>Definition:</b> core_mqtt_agent.c:1085</div></div>
 <div class="ttc" id="acore__mqtt__agent_8h_html_a782425e50d258837d23e379471254412"><div class="ttname"><a href="core__mqtt__agent_8h.html#a782425e50d258837d23e379471254412">MQTTAgent_Connect</a></div><div class="ttdeci">MQTTStatus_t MQTTAgent_Connect(const MQTTAgentContext_t *pMqttAgentContext, MQTTAgentConnectArgs_t *pConnectArgs, const MQTTAgentCommandInfo_t *pCommandInfo)</div><div class="ttdoc">Add a command to call MQTT_Connect() for an MQTT connection. If a session is resumed with the broker,...</div><div class="ttdef"><b>Definition:</b> core_mqtt_agent.c:1275</div></div>

main/mqtt_agent_init_function.html

@@ -107,7 +107,7 @@
 <div class="line">                             MQTTGetCurrentTimeFunc_t getCurrentTimeMs,</div>
 <div class="line">                             <a class="code hl_typedef" href="group__mqtt__agent__callback__types.html#gacdfb8687b1217d321e7cc58e365ec6a1">MQTTAgentIncomingPublishCallback_t</a> incomingCallback,</div>
 <div class="line">                             <span class="keywordtype">void</span> * pIncomingPacketContext );</div>
-<div class="ttc" id="acore__mqtt__agent_8h_html_a584863528e72229f35003485f7ee0edd"><div class="ttname"><a href="core__mqtt__agent_8h.html#a584863528e72229f35003485f7ee0edd">MQTTAgent_Init</a></div><div class="ttdeci">MQTTStatus_t MQTTAgent_Init(MQTTAgentContext_t *pMqttAgentContext, const MQTTAgentMessageInterface_t *pMsgInterface, const MQTTFixedBuffer_t *pNetworkBuffer, const TransportInterface_t *pTransportInterface, MQTTGetCurrentTimeFunc_t getCurrentTimeMs, MQTTAgentIncomingPublishCallback_t incomingCallback, void *pIncomingPacketContext)</div><div class="ttdoc">Perform any initialization the MQTT agent requires before it can be used. Must be called before any o...</div><div class="ttdef"><b>Definition:</b> core_mqtt_agent.c:980</div></div>
+<div class="ttc" id="acore__mqtt__agent_8h_html_a584863528e72229f35003485f7ee0edd"><div class="ttname"><a href="core__mqtt__agent_8h.html#a584863528e72229f35003485f7ee0edd">MQTTAgent_Init</a></div><div class="ttdeci">MQTTStatus_t MQTTAgent_Init(MQTTAgentContext_t *pMqttAgentContext, const MQTTAgentMessageInterface_t *pMsgInterface, const MQTTFixedBuffer_t *pNetworkBuffer, const TransportInterface_t *pTransportInterface, MQTTGetCurrentTimeFunc_t getCurrentTimeMs, MQTTAgentIncomingPublishCallback_t incomingCallback, void *pIncomingPacketContext)</div><div class="ttdoc">Perform any initialization the MQTT agent requires before it can be used. Must be called before any o...</div><div class="ttdef"><b>Definition:</b> core_mqtt_agent.c:968</div></div>
 <div class="ttc" id="agroup__mqtt__agent__callback__types_html_gacdfb8687b1217d321e7cc58e365ec6a1"><div class="ttname"><a href="group__mqtt__agent__callback__types.html#gacdfb8687b1217d321e7cc58e365ec6a1">MQTTAgentIncomingPublishCallback_t</a></div><div class="ttdeci">void(* MQTTAgentIncomingPublishCallback_t)(struct MQTTAgentContext *pMqttAgentContext, uint16_t packetId, MQTTPublishInfo_t *pPublishInfo)</div><div class="ttdoc">Callback function called when receiving a publish.</div><div class="ttdef"><b>Definition:</b> core_mqtt_agent.h:142</div></div>
 <div class="ttc" id="agroup__mqtt__enum__types_html_gaba7ec045874a1c3432f99173367f735c"><div class="ttname"><a href="coreMQTT/group__mqtt__enum__types.html#gaba7ec045874a1c3432f99173367f735c">MQTTStatus_t</a></div><div class="ttdeci">MQTTStatus_t</div></div>
 <div class="ttc" id="astruct_m_q_t_t_agent_context__t_html"><div class="ttname"><a href="struct_m_q_t_t_agent_context__t.html">MQTTAgentContext_t</a></div><div class="ttdoc">Information used by each MQTT agent. A context will be initialized by MQTTAgent_Init(),...</div><div class="ttdef"><b>Definition:</b> core_mqtt_agent.h:153</div></div>