Skip to content

Commit 30bd827

Browse files
committed
[docs] Fixed SRTO_LINGER default values.
1 parent 63026dc commit 30bd827

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

docs/API/API-socket-options.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ The following table lists SRT API socket options in alphabetical order. Option d
216216
| [`SRTO_KMREFRESHRATE`](#SRTO_KMREFRESHRATE) | 1.3.2 | pre | `int32_t` | pkts | 0: 2<sup>24</sup> | 0.. | RW | GSD |
217217
| [`SRTO_KMSTATE`](#SRTO_KMSTATE) | 1.0.2 | | `int32_t` | enum | | | R | S |
218218
| [`SRTO_LATENCY`](#SRTO_LATENCY) | 1.0.2 | pre | `int32_t` | ms | 120 \* | 0.. | RW | GSD |
219-
| [`SRTO_LINGER`](#SRTO_LINGER) | | post | `linger` | s | on, 180 | 0.. | RW | GSD |
219+
| [`SRTO_LINGER`](#SRTO_LINGER) | | post | `linger` | s | off \* | 0.. | RW | GSD |
220220
| [`SRTO_LOSSMAXTTL`](#SRTO_LOSSMAXTTL) | 1.2.0 | post | `int32_t` | packets | 0 | 0.. | RW | GSD+ |
221221
| [`SRTO_MAXBW`](#SRTO_MAXBW) | | post | `int64_t` | B/s | -1 | -1.. | RW | GSD |
222222
| [`SRTO_MESSAGEAPI`](#SRTO_MESSAGEAPI) | 1.3.0 | pre | `bool` | | true | | W | GSD |
@@ -709,9 +709,13 @@ be sender and receiver at the same time, and `SRTO_SENDER` became redundant.
709709

710710
| OptName | Since | Restrict | Type | Units | Default | Range | Dir | Entity |
711711
| -------------------- | ----- | -------- | ---------- | ------ | -------- | ------ | --- | ------ |
712-
| `SRTO_LINGER` | | pre | `linger` | s | on, 180 | 0.. | RW | GSD |
712+
| `SRTO_LINGER` | | pre | `linger` | s | off \* | 0.. | RW | GSD |
713+
714+
SRT socket linger time on close (similar to [SO\_LINGER](http://man7.org/linux/man-pages/man7/socket.7.html)).
715+
The defulat value in [the live streaming configuration](./API.md#transmission-types) is OFF. In this type of workflow there is no point for wait for all the data
716+
to be delivered after a connection is closed.
717+
The default value in [the file transfer configuration](./API.md#transmission-types) is 180 s.
713718

714-
Linger time on close (see [SO\_LINGER](http://man7.org/linux/man-pages/man7/socket.7.html)).
715719

716720
*SRT recommended value*: off (0).
717721

docs/API/API.md

+2
Original file line numberDiff line numberDiff line change
@@ -525,6 +525,7 @@ Setting `SRTO_TRANSTYPE` to `SRTT_LIVE` sets the following [socket options](API-
525525
- [`SRTO_RCVLATENCY`](API-socket-options.md#SRTO_RCVLATENCY) = 120
526526
- [`SRTO_PEERLATENCY`](API-socket-options.md#SRTO_PEERLATENCY) = 0
527527
- [`SRTO_TLPKTDROP`](API-socket-options.md#SRTO_TLPKTDROP) = true
528+
- [`SRTO_LINGER`](API-socket-options.md#SRTO_LINGER) = 0
528529
- [`SRTO_MESSAGEAPI`](API-socket-options.md#SRTO_MESSAGEAPI) = true
529530
- [`SRTO_NAKREPORT`](API-socket-options.md#SRTO_NAKREPORT) = true
530531
- [`SRTO_RETRANSMITALGO`](API-socket-options.md#SRTO_RETRANSMITALGO) = 1
@@ -607,6 +608,7 @@ Setting `SRTO_TRANSTYPE` to `SRTT_FILE` sets the following [socket options](API-
607608
- [`SRTO_RCVLATENCY`](API-socket-options.md#SRTO_RCVLATENCY) = 0
608609
- [`SRTO_PEERLATENCY`](API-socket-options.md#SRTO_PEERLATENCY) = 0
609610
- [`SRTO_TLPKTDROP`](API-socket-options.md#SRTO_TLPKTDROP) = false
611+
- [`SRTO_LINGER`](API-socket-options.md#SRTO_LINGER) = 180 s
610612
- [`SRTO_MESSAGEAPI`](API-socket-options.md#SRTO_MESSAGEAPI) = false
611613
- [`SRTO_NAKREPORT`](API-socket-options.md#SRTO_NAKREPORT) = false
612614
- [`SRTO_RETRANSMITALGO`](API-socket-options.md#SRTO_RETRANSMITALGO) = 0

0 commit comments

Comments
 (0)