FreeRTOS/coreMQTT
1
0
Fork 0
mirror of https://github.com/FreeRTOS/coreMQTT synced 2025-06-06 11:48:52 +08:00
Code Issues Releases Wiki Activity

Align wording of Init with porting guide (#95)

Browse Source 
* Align wording of Init with porting guide

* Also add notes for connect, processloop, and receiveloop
This commit is contained in:
Muneeb Ahmed 2020-10-30 11:30:00 -07:00 committed by GitHub
parent a34048debe
commit 1bb7a23f5c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
source/include/core_mqtt.h
View File

@ -231,8 +231,9 @@ typedef struct MQTTDeserializedInfo
* @note The #MQTTGetCurrentTimeFunc_t callback function must be defined. If
* there is no time implementation, it is the responsibility of the application
* to provide a dummy function to always return 0, and provide 0 timeouts for
* functions. This will ensure all time based functions will run for a single
* iteration.
* all calls to #MQTT_Connect, #MQTT_ProcessLoop, and #MQTT_ReceiveLoop. This
* will result in loop functions running for a single iteration, and #MQTT_Connect
* relying on #MQTT_MAX_CONNACK_RECEIVE_RETRY_COUNT to receive the CONNACK packet.
*
* @param[in] pContext The context to initialize.
* @param[in] pTransportInterface The transport interface to use with the context.
@ -309,6 +310,9 @@ MQTTStatus_t MQTT_Init( MQTTContext_t * pContext,
* The network receive for CONNACK is retried up to the number of times
* configured by #MQTT_MAX_CONNACK_RECEIVE_RETRY_COUNT.
*
* @note If a dummy #MQTTGetCurrentTimeFunc_t was passed to #MQTT_Init, then the
* timeout MUST be set to 0.
*
* @param[in] pContext Initialized MQTT context.
* @param[in] pConnectInfo MQTT CONNECT packet information.
* @param[in] pWillInfo Last Will and Testament. Pass NULL if Last Will and
@ -591,6 +595,10 @@ MQTTStatus_t MQTT_Disconnect( MQTTContext_t * pContext );
* @brief Loop to receive packets from the transport interface. Handles keep
* alive.
*
* @note Passing a timeout value of 0 will run the loop for a single iteration.
* If a dummy #MQTTGetCurrentTimeFunc_t was passed to #MQTT_Init, then this
* timeout MUST be set to 0.
*
* @param[in] pContext Initialized and connected MQTT context.
* @param[in] timeoutMs Minimum time in milliseconds that the receive loop will
* run, unless an error occurs.
@ -640,6 +648,8 @@ MQTTStatus_t MQTT_ProcessLoop( MQTTContext_t * pContext,
* keep alive.
*
* @note Passing a timeout value of 0 will run the loop for a single iteration.
* If a dummy #MQTTGetCurrentTimeFunc_t was passed to #MQTT_Init, then this
* timeout MUST be set to 0.
*
* @param[in] pContext Initialized and connected MQTT context.
* @param[in] timeoutMs Minimum time in milliseconds that the receive loop will