Struct datachannel_facade::DataChannelOptions

pub struct DataChannelOptions {
    pub ordered: bool,
    pub max_packet_life_time: Option<u16>,
    pub max_retransmits: Option<u16>,
    pub protocol: String,
    pub negotiated: bool,
    pub id: Option<u16>,
}

An object providing configuration options for the data channel. It can contain the following fields:

Fields

ordered: bool

Indicates whether or not messages sent on the RTCDataChannel are required to arrive at their destination in the same order in which they were sent (true), or if they’re allowed to arrive out-of-order (false). Default: true.

max_packet_life_time: Option<u16>

The maximum number of milliseconds that attempts to transfer a message may take in unreliable mode. While this value is a 16-bit unsigned number, each user agent may clamp it to whatever maximum it deems appropriate. Default: null.

max_retransmits: Option<u16>

The maximum number of times the user agent should attempt to retransmit a message which fails the first time in unreliable mode. While this value is a 16-bit unsigned number, each user agent may clamp it to whatever maximum

protocol: String

The name of the sub-protocol being used on the RTCDataChannel, if any; otherwise, the empty string (“”). Default: empty string (“”). This string may not be longer than 65,535 bytes.

negotiated: bool

By default (false), data channels are negotiated in-band, where one side calls createDataChannel, and the other side listens to the RTCDataChannelEvent event using the ondatachannel event handler. Alternatively (true), they can be negotiated out of-band, where both sides call createDataChannel with an agreed-upon ID. Default: false.

id: Option<u16>

A 16-bit numeric ID for the channel; permitted values are 0 to 65534. If you don’t include this option, the user agent will select an ID for you.

Trait Implementations

impl Default for DataChannelOptions

fn default() -> Self

Returns the “default value” for a type.