Update API doc about timeout configs when timer is dummy #128
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When the application uses a dummy
MQTTGetCurrentTimeFunc_ttimer that always returns zero, there can be an infinite loop if the default values for the send/receive timeout configurations are used and no data is sent/received in the calls to the transport interface send/receive functions.To avoid this behavior, the
MQTT_RECV_POLLING_TIMEOUT_MSandMQTT_SEND_RETRY_TIMEOUT_MSMUST be set to zero when using a dummy timer function. This PR updates the API documentation accordingly.