Struct ChannelConfig 

pub struct ChannelConfig { /* private fields */ }

Stable configuration descriptor for a DataChannel pre-registration.

One ChannelConfig is pushed into the client’s DC list by every with_extra_dc / with_chat_dcs / with_voice_dc call. The SFU application (e.g. partner-edge) reads these out via Client::extra_dcs() during offer/answer negotiation and passes them to Rtc::open_stream.

Invariant

Exactly one of max_packet_lifetime_ms and max_retransmits is Some for unreliable channels; both are None for reliable channels. Both being Some simultaneously is undefined behaviour in str0m. The three constructors enforce this; constructing ChannelConfig via struct literal outside this module is not possible (fields are pub(crate)).

Implementations

impl ChannelConfig

pub fn reliable_ordered() -> Self

Reliable, ordered DataChannel (TCP-like semantics).

Used by with_chat_dcs for the "chat-data" channel (id=4).

pub fn unreliable_max_retransmits(retransmits: u16) -> Self

Unordered, unreliable DataChannel with a max-retransmit count.

Pass retransmits = 0 for fire-and-forget semantics. Used by with_chat_dcs for the "chat-ctrl" channel (id=5).

pub fn unreliable_max_lifetime(lifetime_ms: u32) -> Self

Unordered, unreliable DataChannel with a max-packet-lifetime in milliseconds.

Maps to str0m::channel::Reliability::MaxPacketLifetime. Used by with_voice_dc for low-latency voice data signalling (id=6).

Note: str0m’s internal representation uses u16; callers converting to str0m must try_into::<u16>() on the stored value.

pub fn id(&self) -> u16

SCTP stream identifier. Must be unique per peer-connection.

pub fn label(&self) -> &str

Human-readable channel label (e.g. "chat-data", "voice").

pub fn ordered(&self) -> bool

Whether in-order delivery is required.

pub fn max_packet_lifetime_ms(&self) -> Option<u32>

Maximum packet lifetime in milliseconds, if set.

Some only for unreliable channels using Reliability::MaxPacketLifetime. Mutually exclusive with max_retransmits.

pub fn max_retransmits(&self) -> Option<u16>

Maximum number of retransmits before discarding, if set.

Some only for unreliable channels using Reliability::MaxRetransmits. Mutually exclusive with max_packet_lifetime_ms.

Trait Implementations

impl Clone for ChannelConfig

fn clone(&self) -> ChannelConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ChannelConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ChannelConfig

fn eq(&self, other: &ChannelConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ChannelConfig

impl StructuralPartialEq for ChannelConfig