Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add MQTTNeedMoreBytes to Receive and Process Loop documentation. #225

Merged
merged 1 commit into from
Oct 12, 2022
Merged

Add MQTTNeedMoreBytes to Receive and Process Loop documentation. #225

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions source/include/core_mqtt.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -748,6 +748,8 @@ MQTTStatus_t MQTT_Disconnect( MQTTContext_t * pContext );
* #MQTT_PINGRESP_TIMEOUT_MS milliseconds;
* #MQTTIllegalState if an incoming QoS 1/2 publish or ack causes an
* invalid transition for the internal state machine;
* #MQTTNeedMoreBytes if MQTT_ProcessLoop has received
* incomplete data; it should be called again (probably after a delay);
* #MQTTSuccess on success.
*
* <b>Example</b>
Expand All @@ -762,7 +764,7 @@ MQTTStatus_t MQTT_Disconnect( MQTTContext_t * pContext );
* {
* status = MQTT_ProcessLoop( pContext );
*
* if( status != MQTTSuccess )
* if( status != MQTTSuccess && status != MQTTNeedMoreBytes )
* {
* // Determine the error. It's possible we might need to disconnect
* // the underlying transport connection.
Expand Down Expand Up @@ -802,6 +804,8 @@ MQTTStatus_t MQTT_ProcessLoop( MQTTContext_t * pContext );
* #MQTTBadResponse if an invalid packet is received;
* #MQTTIllegalState if an incoming QoS 1/2 publish or ack causes an
* invalid transition for the internal state machine;
* #MQTTNeedMoreBytes if MQTT_ReceiveLoop has received
* incomplete data; it should be called again (probably after a delay);
* #MQTTSuccess on success.
*
* <b>Example</b>
Expand All @@ -817,7 +821,7 @@ MQTTStatus_t MQTT_ProcessLoop( MQTTContext_t * pContext );
* {
* status = MQTT_ReceiveLoop( pContext );
*
* if( status != MQTTSuccess )
* if( status != MQTTSuccess && status != MQTTNeedMoreBytes )
* {
* // Determine the error. It's possible we might need to disconnect
* // the underlying transport connection.
Expand Down