[docs] Added SRTO_PACINGMODE option #1533
Conversation
mbakholdina
added
[docs]
docs/APISocketOptions.md
Outdated
| | Mode / Option | SRTO_MAXBW | SRTO_INPUTBW | SRT_OHEADBW | Formula for `MAXBW` Calculation | | ||
| | ------------------------ | ---------- | ------------ | ----------- | ------------------------------------------------------------ | | ||
| | `SRT_PACING_DEFMAXBW` | -1 | - | - | `MAXBW` is set to the default value of 1Gbps | | ||
| | `SRT_PACING_MAXBW` | ✓ | - | - | `MAXBW` is set explicitly, in bytes per second | | ||
| | `SRT_PACING_INPUTBW` | 0 | ✓ | ✓ | `MAXBW = INPUTBW * (1 + OHEADBW /100)` | | ||
| | `SRT_PACING_ESTINPUTBW` | 0 | 0 | ✓ | `MAXBW = ESTINPUTBW * (1 + OHEADBW /100)` | | ||
| | `SRT_PACING_HYBRIDBW` | 0 | ✓ | ✓ | `MAX_BW = max(INPUTBW, ESTINPUT_BW) * (1 + OHEADBW /100)` | |
There was a problem hiding this comment.
For convenience the other possible mode value SRT_PACING_UNSET should also be listed in the table.
docs/APISocketOptions.md
Outdated
|
|
||
| See section (TODO: insert link to the new RFC draft once published) for the detailed description of pacing control modes. | ||
|
|
||
| It's important to note that options [SRTO_MAXBW](#SRTO_MAXBW), [SRTO_INPUTBW](#SRTO_INPUTBW) and [SRT_OHEADBW](#SRT_OHEADBW) should be set first, right before setting the `SRTO_PACINGMODE` option. The order is important. In case the combination of `SRTO_MAXBW`, `SRTO_INPUTBW` and `SRTO_OHEADBW` options is configured wrong for a particular pacing control mode, SRT will throw an error (TODO: discuss what kind of error and put this information here). |
There was a problem hiding this comment.
| It's important to note that options [SRTO_MAXBW](#SRTO_MAXBW), [SRTO_INPUTBW](#SRTO_INPUTBW) and [SRT_OHEADBW](#SRT_OHEADBW) should be set first, right before setting the `SRTO_PACINGMODE` option. The order is important. In case the combination of `SRTO_MAXBW`, `SRTO_INPUTBW` and `SRTO_OHEADBW` options is configured wrong for a particular pacing control mode, SRT will throw an error (TODO: discuss what kind of error and put this information here). | |
| It's important to note that options [SRTO_MAXBW](#SRTO_MAXBW), [SRTO_INPUTBW](#SRTO_INPUTBW) and [SRTO_OHEADBW](#SRTO_OHEADBW) should be set first, right before setting the `SRTO_PACINGMODE` option. The order is important. In case the combination of `SRTO_MAXBW`, `SRTO_INPUTBW` and `SRTO_OHEADBW` options is configured wrong for a particular pacing control mode, SRT will throw an error (TODO: discuss what kind of error and put this information here). |
There was a problem hiding this comment.
I don't agree with this. The PACING_MODE vs. MAXBW, INPUTBW, OHEADBW table was to compare manual setting vs. PACING setting. I thought the PR was taking care of settings in any order. PACING_MODE setting shall simplify, not complexify configuration. For example, setting SRT_PACING_ESTINPUTBW would force set MAXBW and INPUTBW to 0. only OHEADBW is required, before or after PACING_MODE. I think the approach of the PR is that the last setting is applied. For example setting a non-0 value in INPUTBW after setting SRT_PACING_ESTINPUTBW would switch the mode to SRT_PACING_INPUTBW. It could have been SRT_PACING_HYBRIDBW (even more logic). Particular care was taken to preserve backward compatibility and a neutral behavior for application not setting PACING_MODE. If error are thrown it should not be for applications working properly with previous releases.
mbakholdina
modified the milestones:
v1.5.0 - Sprint 23,
v1.5.0 - Sprint 24,
v1.5.0 - Sprint 25
Added
SRTO_PACINGMODEoption plus relevant corrections toSRTO_MAXBW,SRTO_INPUTBWandSRTO_OHEADBWoptions. To be merged together with PR #1383. This is a replacement of documentation provided in mentioned PR.TODO:
SRTO_PACINGMODEand a combination ofSRTO_MAXBW,SRTO_INPUTBWandSRTO_OHEADBWoptions -> add this information into documentation.