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

Jump to bottom

[docs] Improved latency description in APISocketOptions #1607

Merged
merged 4 commits into from
Oct 20, 2020
Merged

[docs] Improved latency description in APISocketOptions #1607

merged 4 commits into from
Oct 20, 2020

Conversation

maxsharabayko
Copy link
Collaborator

This PR improves the description of latency related SRT socket options:

  • SRTO_LATENCY
  • SRTO_RCVLATENCY
  • SRT_PEERLATENCY

It also fixes some minor mistakes in the APISocketOptions.md.

  • Some occurrences of "msec" is renamed to "ms".
  • "8192 buffs" is changed to "8192 payloads (SRTO_RCVBUF, SRTO_SNDBUF, SRTO_UDP_RCVBUF).
  • Added missing "Return to list" hyperlink to the SRTO_CONGESTION section.
  • Fixed list formatting in the SRTO_MAXBW section.

Closes #1210

@maxsharabayko maxsharabayko added Type: Maintenance Work required to maintain or clean up the code [docs] Area: Improvements or additions to documentation labels Oct 14, 2020
@maxsharabayko maxsharabayko added this to the v1.5.0 milestone Oct 14, 2020
@maxsharabayko maxsharabayko self-assigned this Oct 14, 2020
stevomatthews
stevomatthews reviewed Oct 14, 2020
View reviewed changes
Copy link
Collaborator

@stevomatthews stevomatthews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor edits.

@maxsharabayko @stevomatthews
Apply suggestions from code review
076cfe8 
Co-authored-by: stevomatthews <smatthews@haivision.com>
ethouris
ethouris reviewed Oct 19, 2020
View reviewed changes
docs/APISocketOptions.md Outdated Show resolved Hide resolved
ethouris
ethouris reviewed Oct 19, 2020
View reviewed changes
Copy link
Collaborator

@ethouris ethouris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider changing according to the comments.

stevomatthews
stevomatthews approved these changes Oct 20, 2020
View reviewed changes
Copy link
Collaborator

@stevomatthews stevomatthews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

@maxsharabayko maxsharabayko merged commit f821125 into Haivision:master Oct 20, 2020
@maxsharabayko maxsharabayko deleted the docs/apisockopts-small-fix branch October 20, 2020 14:10
@maxsharabayko maxsharabayko modified the milestones: v1.5.0, v1.4.3 Oct 22, 2020
@maxsharabayko maxsharabayko mentioned this pull request May 3, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stevomatthews stevomatthews stevomatthews approved these changes

@ethouris ethouris ethouris approved these changes

Assignees

@maxsharabayko maxsharabayko

Labels
[docs] Area: Improvements or additions to documentation Type: Maintenance Work required to maintain or clean up the code
Projects
None yet
Milestone
v1.4.3
Development

Successfully merging this pull request may close these issues.

Improve description of latency related options (e.g. SRTO_RCVLATENCY)
3 participants
@maxsharabayko @ethouris @stevomatthews