Created a detailed documentation for SRT API functions #540
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
ethouris
commented
Feb 1, 2019
docs/API-functions.md
Outdated
| * `SRT_EINVALBUFFERAPI`: Incorrect API usage in stream mode: | ||
| * Currently not in use. The FileSmoother used as the only for stream | ||
| mode does not restrict the parameters. | ||
| * `SRT_ELARGEMSG`: Message to be sent can't fit in the sending buffer (that is, |
There was a problem hiding this comment.
Wrong, this is an error that describes the sendmsg call. Something wrong here.
ethouris
commented
Feb 1, 2019
docs/API-functions.md
Outdated
| const char* srt_getlasterror_str(void); | ||
| ``` | ||
|
|
||
| Get the text message for the last error. |
There was a problem hiding this comment.
Needed information that the error is stored in a thread-local storage, so it is valid until calling the next function that might affect it.
ethouris
commented
Feb 1, 2019
docs/API-functions.md
Outdated
| the packet sequence number that was last reported by ACK message and the | ||
| sequence number of the packet just sent. Note that ACK gets received | ||
| periodically, so this value is most accurate just after receiving ACK and | ||
| becomes a little exaggerated in time until the next ACK comes. |
There was a problem hiding this comment.
Research may be necessary to find out if this value shouldn't be (or even isn't) calculated as the distance between the packet that was last ACK-ed and the packet that was the last sent sequence at the same time when receiving the ACK (not at the time when the query was made).
ethouris
commented
Feb 1, 2019
docs/API-functions.md
Outdated
| data scheduled for sending by the application and increases with every ACK | ||
| received from the receiver, after the packets are sent over the UDP link. | ||
|
|
||
| * ` byteAvailRcvBuf`: Bytes available in the receiver buffer. |
maxsharabayko
requested changes
Feb 4, 2019
| // perfmon with Byte counters for better bitrate estimation. | ||
| int srt_bstats(SRTSOCKET u, SRT_TRACEBSTATS * perf, int clear); | ||
|
|
||
| // permon with Byte counters and instantaneous stats instead of moving averages for Snd/Rcvbuffer sizes. |
There was a problem hiding this comment.
"permon" or "perfmon"?
maxsharabayko
approved these changes
Feb 8, 2019
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.
This completes the API description with all required details concerning API functions.
A controversial thing here can be an inevitable statement used sometimes that there are still bugs or design flaws in the area of error types returned; it would be desired that these bugs are fixed ASAP, but if they are not, and not mentioned here, they might be quickly forgotten.