Enum DataConsumer

#[non_exhaustive]
pub enum DataConsumer {
    Regular(RegularDataConsumer),
    Direct(DirectDataConsumer),
}

A data consumer represents an endpoint capable of receiving data messages from a mediasoup Router.

A data consumer can use SCTP (AKA DataChannel) to receive those messages, or can directly receive them in the Rust application if the data consumer was created on top of a DirectTransport.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Regular(RegularDataConsumer)

Data consumer created on transport other than DirectTransport.

Direct(DirectDataConsumer)

Data consumer created on DirectTransport.

Implementations

impl DataConsumer

pub fn id(&self) -> DataConsumerId

Data consumer identifier.

pub fn data_producer_id(&self) -> DataProducerId

The associated data producer identifier.

pub fn transport(&self) -> &Arc<dyn Transport>

Transport to which data consumer belongs.

pub fn type(&self) -> DataConsumerType

The type of the data consumer.

pub fn paused(&self) -> bool

Whether the data consumer is paused. It does not take into account whether the associated data producer is paused.

pub fn producer_paused(&self) -> bool

Whether the associate data producer is paused.

pub fn sctp_stream_parameters(&self) -> Option<SctpStreamParameters>

The SCTP stream parameters (just if the data consumer type is Sctp).

pub fn label(&self) -> &String

The data consumer label.

pub fn protocol(&self) -> &String

The data consumer sub-protocol.

pub fn subchannels(&self) -> Vec<u16>

The data consumer subchannels.

pub fn app_data(&self) -> &AppData

Custom application data.

pub fn closed(&self) -> bool

Whether the data consumer is closed.

pub async fn get_stats(&self) -> Result<Vec<DataConsumerStat>, RequestError>

Returns current statistics of the data consumer.

Check the RTC Statistics section for more details (TypeScript-oriented, but concepts apply here as well).

pub async fn pause(&self) -> Result<(), RequestError>

Pauses the data consumer (no mossage is sent to the consuming endpoint).

pub async fn resume(&self) -> Result<(), RequestError>

Resumes the data consumer (messages are sent again to the consuming endpoint).

pub async fn get_buffered_amount(&self) -> Result<u32, RequestError>

Returns the number of bytes of data currently buffered to be sent over the underlying SCTP association.

Notes on usage

The underlying SCTP association uses a common send buffer for all data consumers, hence the value given by this method indicates the data buffered for all data consumers in the transport.

pub async fn set_buffered_amount_low_threshold( &self, threshold: u32, ) -> Result<(), RequestError>

Whenever the underlying SCTP association buffered bytes drop to this value, on_buffered_amount_low callback is called.

pub async fn set_subchannels( &self, subchannels: Vec<u16>, ) -> Result<(), RequestError>

Sets subchannels to the worker DataConsumer.

pub async fn add_subchannel(&self, subchannel: u16) -> Result<(), RequestError>

Adds a subchannel to the worker DataConsumer.

pub async fn remove_subchannel( &self, subchannel: u16, ) -> Result<(), RequestError>

Removes a subchannel to the worker DataConsumer.

pub fn on_message<F: Fn(&WebRtcMessage<'_>) + Send + Sync + 'static>( &self, callback: F, ) -> HandlerId

Callback is called when a message has been received from the corresponding data producer.

Notes on usage

Just available in direct transports, this is, those created via Router::create_direct_transport.

pub fn on_sctp_send_buffer_full<F: Fn() + Send + Sync + 'static>( &self, callback: F, ) -> HandlerId

Callback is called when a message could not be sent because the SCTP send buffer was full.

pub fn on_buffered_amount_low<F: Fn(u32) + Send + Sync + 'static>( &self, callback: F, ) -> HandlerId

Emitted when the underlying SCTP association buffered bytes drop down to the value set with DataConsumer::set_buffered_amount_low_threshold.

Notes on usage

Only applicable for consumers of type Sctp.

pub fn on_data_producer_close<F: FnOnce() + Send + 'static>( &self, callback: F, ) -> HandlerId

Callback is called when the associated data producer is closed for whatever reason. The data consumer itself is also closed.

pub fn on_pause<F: Fn() + Send + Sync + 'static>( &self, callback: F, ) -> HandlerId

Callback is called when the data consumer or its associated data producer is paused and, as result, the data consumer becomes paused.

pub fn on_resume<F: Fn() + Send + Sync + 'static>( &self, callback: F, ) -> HandlerId

Callback is called when the data consumer or its associated data producer is resumed and, as result, the data consumer is no longer paused.

pub fn on_data_producer_pause<F: Fn() + Send + Sync + 'static>( &self, callback: F, ) -> HandlerId

Callback is called when the associated data producer is paused.

pub fn on_data_producer_resume<F: Fn() + Send + Sync + 'static>( &self, callback: F, ) -> HandlerId

Callback is called when the associated data producer is resumed.

pub fn on_transport_close<F: FnOnce() + Send + 'static>( &self, callback: F, ) -> HandlerId

Callback is called when the transport this data consumer belongs to is closed for whatever reason. The data consumer itself is also closed.

pub fn on_close<F: FnOnce() + Send + 'static>(&self, callback: F) -> HandlerId

Callback is called when the data consumer is closed for whatever reason.

NOTE: Callback will be called in place if data consumer is already closed.

pub fn downgrade(&self) -> WeakDataConsumer

Downgrade DataConsumer to WeakDataConsumer instance.

Trait Implementations

impl Clone for DataConsumer

fn clone(&self) -> DataConsumer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DataConsumer

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

Formats the value using the given formatter.

impl From<DirectDataConsumer> for DataConsumer

fn from(producer: DirectDataConsumer) -> Self

Converts to this type from the input type.

impl From<RegularDataConsumer> for DataConsumer

fn from(producer: RegularDataConsumer) -> Self

Converts to this type from the input type.