Commit 83ed11b1 authored by Limin Wang's avatar Limin Wang

doc/protocols: clarify timeout and latency unit of measurement for SRT

Signed-off-by: 's avatarLimin Wang <lance.lmwang@gmail.com>
parent f821ae85
...@@ -1255,7 +1255,7 @@ options. ...@@ -1255,7 +1255,7 @@ options.
This protocol accepts the following options. This protocol accepts the following options.
@table @option @table @option
@item connect_timeout @item connect_timeout=@var{milliseconds}
Connection timeout; SRT cannot connect for RTT > 1500 msec Connection timeout; SRT cannot connect for RTT > 1500 msec
(2 handshake exchanges) with the default connect timeout of (2 handshake exchanges) with the default connect timeout of
3 seconds. This option applies to the caller and rendezvous 3 seconds. This option applies to the caller and rendezvous
...@@ -1286,7 +1286,7 @@ IP Type of Service. Applies to sender only. Default value is 0xB8. ...@@ -1286,7 +1286,7 @@ IP Type of Service. Applies to sender only. Default value is 0xB8.
@item ipttl=@var{ttl} @item ipttl=@var{ttl}
IP Time To Live. Applies to sender only. Default value is 64. IP Time To Live. Applies to sender only. Default value is 64.
@item latency @item latency=@var{microseconds}
Timestamp-based Packet Delivery Delay. Timestamp-based Packet Delivery Delay.
Used to absorb bursts of missed packet retransmissions. Used to absorb bursts of missed packet retransmissions.
This flag sets both @option{rcvlatency} and @option{peerlatency} This flag sets both @option{rcvlatency} and @option{peerlatency}
...@@ -1297,7 +1297,7 @@ when side is sender and @option{rcvlatency} ...@@ -1297,7 +1297,7 @@ when side is sender and @option{rcvlatency}
when side is receiver, and the bidirectional stream when side is receiver, and the bidirectional stream
sending is not supported. sending is not supported.
@item listen_timeout @item listen_timeout=@var{microseconds}
Set socket listen timeout. Set socket listen timeout.
@item maxbw=@var{bytes/seconds} @item maxbw=@var{bytes/seconds}
...@@ -1377,7 +1377,7 @@ use a bigger maximum frame size, though not greater than ...@@ -1377,7 +1377,7 @@ use a bigger maximum frame size, though not greater than
@item pkt_size=@var{bytes} @item pkt_size=@var{bytes}
Alias for @samp{payload_size}. Alias for @samp{payload_size}.
@item peerlatency @item peerlatency=@var{microseconds}
The latency value (as described in @option{rcvlatency}) that is The latency value (as described in @option{rcvlatency}) that is
set by the sender side as a minimum value for the receiver. set by the sender side as a minimum value for the receiver.
...@@ -1389,7 +1389,7 @@ Not required on receiver (set to 0), ...@@ -1389,7 +1389,7 @@ Not required on receiver (set to 0),
key size obtained from sender in HaiCrypt handshake. key size obtained from sender in HaiCrypt handshake.
Default value is 0. Default value is 0.
@item rcvlatency @item rcvlatency=@var{microseconds}
The time that should elapse since the moment when the The time that should elapse since the moment when the
packet was sent and the moment when it's delivered to packet was sent and the moment when it's delivered to
the receiver application in the receiving function. the receiver application in the receiving function.
...@@ -1407,7 +1407,7 @@ Set UDP receive buffer size, expressed in bytes. ...@@ -1407,7 +1407,7 @@ Set UDP receive buffer size, expressed in bytes.
@item send_buffer_size=@var{bytes} @item send_buffer_size=@var{bytes}
Set UDP send buffer size, expressed in bytes. Set UDP send buffer size, expressed in bytes.
@item timeout @item timeout=@var{microseconds}
Set raise error timeouts for read, write and connect operations. Note that the Set raise error timeouts for read, write and connect operations. Note that the
SRT library has internal timeouts which can be controlled separately, the SRT library has internal timeouts which can be controlled separately, the
value set here is only a cap on those. value set here is only a cap on those.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment