Fixed correct description for msgttl #847
Merged
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
rndi
suggested changes
Sep 12, 2019
docs/API-functions.md
Outdated
| stay scheduled for sending for the sake of later retransmission. A message | ||
| is always sent for the first time, but the UDP packet carrying it may be | ||
| (also partially) lost. In this case, a message with a limited TTL will be | ||
| given up retransmission and discarded, if this time passes. |
There was a problem hiding this comment.
If the message is not successfully resent before its TTL expires, its retransmission is given up and it is discarded.
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.
Fixes #661
There was a mistaken description of msgttl suggesting that the message will be waiting in the sender buffer for a chance to be sent and discarded completely after TTL passes. It was a wrong statement suggesting that the message may be not sent at all even once, which isn't true - the message is always sent at least once. The TTL value is considered only in the function that is used for retransmission.