SockOpt

Parameter or returned value of SrtSocket.setSockFlag and SrtSocket.getSockFlag.

See Also: API Socket Options

Entries

Link copied to clipboard

The Maximum Transfer Unit

Link copied to clipboard

If sending is blocking

Link copied to clipboard

If receiving is blocking

Link copied to clipboard

Initial Sequence Number (valid only after srt_connect or srt_accept-ed sockets)

Link copied to clipboard

Flight flag size (window size)

Link copied to clipboard

Maximum buffer in sending queue

Link copied to clipboard

UDT receiving buffer size

Link copied to clipboard

Waiting for unsent data when closing

Link copied to clipboard

UDP sending buffer size

Link copied to clipboard

UDP receiving buffer size

Link copied to clipboard

Rendezvous connection mode

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Reuse an existing port or create a new one

Link copied to clipboard

Maximum bandwidth (bytes per second) that the connection can use

Link copied to clipboard

Current socket state, see UDTSTATUS, read only

Link copied to clipboard

Current available events associated with the socket

Link copied to clipboard

Size of data in the sending buffer

Link copied to clipboard

Size of data available for recv

Link copied to clipboard

Sender mode (independent of conn mode), for encryption, tsbpd handshake.

Link copied to clipboard

Enable/Disable TsbPd. Enable -> Tx set origin timestamp, Rx deliver packet at origin time + delay

Link copied to clipboard

NOT RECOMMENDED. SET: to both RCVLATENCY and PEERLATENCY. GET: same as RCVLATENCY.

Link copied to clipboard

Estimated input stream rate.

Link copied to clipboard

Minimum estimate of input stream rate.

Link copied to clipboard

MaxBW ceiling based on % over input stream rate. Applies when UDT_MAXBW=0 (auto).

Link copied to clipboard

Crypto PBKDF2 Passphrase size (0,10..64) 0:disable crypto

Link copied to clipboard

Crypto key len in bytes {16,24,32} Default: 16 (128-bit)

Link copied to clipboard

Key Material exchange status (UDT_SRTKmState)

Link copied to clipboard

IP Time To Live (passthru for system sockopt IPPROTO_IP/IP_TTL)

Link copied to clipboard

IP Type of Service (passthru for system sockopt IPPROTO_IP/IP_TOS)

Link copied to clipboard

Enable receiver pkt drop

Link copied to clipboard

Extra delay towards latency for sender TLPKTDROP decision (-1 to off)

Link copied to clipboard

Enable receiver to send periodic NAK reports

Link copied to clipboard

Local SRT Version

Link copied to clipboard

Peer SRT Version (from SRT Handshake)

Link copied to clipboard

Connect timeout in msec. Caller default: 3000, rendezvous (x 10)

Link copied to clipboard

Enable or disable drift tracer

Link copied to clipboard

(GET) the current state of the encryption at the peer side

Link copied to clipboard

(GET) the current state of the encryption at the agent side

Link copied to clipboard

Maximum possible packet reorder tolerance (number of packets to receive after loss to send lossreport)

Link copied to clipboard

TsbPd receiver delay (mSec) to absorb burst of missed packet retransmission

Link copied to clipboard

Minimum value of the TsbPd receiver delay (mSec) for the opposite side (peer)

Link copied to clipboard

Minimum SRT version needed for the peer (peers with less version will get connection reject)

Link copied to clipboard

A string set to a socket and passed to the listener's accepted socket

Link copied to clipboard

Congestion controller type selection

Link copied to clipboard

In File mode, use message API (portions of data with boundaries)

Link copied to clipboard

Maximum payload size sent in one UDP packet (0 if unlimited)

Link copied to clipboard

Transmission type (set of options required for given transmission type)

Link copied to clipboard

After sending how many packets the encryption key should be flipped to the new key

Link copied to clipboard

How many packets before key flip the new key is annnounced and after key flip the old one decommissioned

Link copied to clipboard

Connection to be rejected or quickly broken when one side encryption set or bad password

Link copied to clipboard

IPV6_V6ONLY mode

Link copied to clipboard

Peer-idle timeout (max time of silence heard from peer) in ms

Link copied to clipboard

Forward the BINDTODEVICE option on socket (pass packets only from that device)

Link copied to clipboard

Add and configure a packet filter

Link copied to clipboard

An option to select packet retransmission algorithm

Properties

Link copied to clipboard

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
fun valueOf(value: String): SockOpt

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Link copied to clipboard

Returns an array containing the constants of this enum type, in the order they're declared.