Struct DataConsumerOptions

#[non_exhaustive]
pub struct DataConsumerOptions {
    pub paused: bool,
    pub subchannels: Option<Vec<u16>>,
    pub app_data: AppData,
    /* private fields */
}

DataConsumer options.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

paused: bool

Whether the DataConsumer must start in paused mode. Default false.

subchannels: Option<Vec<u16>>

Subchannels this DataConsumer initially subscribes to. Only used in case this DataConsumer receives messages from a local DataProducer that specifies subchannel(s) when calling send().

app_data: AppData

Custom application data.

Implementations

impl DataConsumerOptions

pub fn new_sctp(data_producer_id: DataProducerId) -> Self

Inherits parameters of corresponding DataProducer.

pub fn new_direct( data_producer_id: DataProducerId, subchannels: Option<Vec<u16>>, ) -> Self

For DirectTransport.

pub fn new_sctp_ordered(data_producer_id: DataProducerId) -> Self

Messages will be sent reliably in order.

pub fn new_sctp_unordered_with_life_time( data_producer_id: DataProducerId, max_packet_life_time: u16, ) -> Self

Messages will be sent unreliably with time (in milliseconds) after which a SCTP packet will stop being retransmitted.

pub fn new_sctp_unordered_with_retransmits( data_producer_id: DataProducerId, max_retransmits: u16, ) -> Self

Messages will be sent unreliably with a limited number of retransmission attempts.

Trait Implementations

impl Clone for DataConsumerOptions

fn clone(&self) -> DataConsumerOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DataConsumerOptions

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

Formats the value using the given formatter.