Struct webrtc_data::data_channel::DataChannel

pub struct DataChannel {
    pub config: Config,
    // some fields omitted
}

DataChannel represents a data channel

Fields

config: Config

Implementations

impl DataChannel

pub fn new(stream: Arc<Stream>, config: Config) -> Self

pub async fn dial(
    association: &Arc<Association>,
    identifier: u16,
    config: Config
) -> Result<Self, Error>

Dial opens a data channels over SCTP

pub async fn accept(
    association: &Arc<Association>,
    config: Config
) -> Result<Self, Error>

Accept is used to accept incoming data channels over SCTP

pub async fn client(stream: Arc<Stream>, config: Config) -> Result<Self, Error>

Client opens a data channel over an SCTP stream

pub async fn server(stream: Arc<Stream>, config: Config) -> Result<Self, Error>

Server accepts a data channel over an SCTP stream

pub async fn read(&self, buf: &mut [u8]) -> Result<usize, Error>

Read reads a packet of len(p) bytes as binary data

pub async fn read_data_channel(
    &self,
    buf: &mut [u8]
) -> Result<(usize, bool), Error>

ReadDataChannel reads a packet of len(p) bytes

pub fn messages_sent(&self) -> usize

MessagesSent returns the number of messages sent

pub fn messages_received(&self) -> usize

MessagesReceived returns the number of messages received

pub fn bytes_sent(&self) -> usize

BytesSent returns the number of bytes sent

pub fn bytes_received(&self) -> usize

BytesReceived returns the number of bytes received

pub fn stream_identifier(&self) -> u16

StreamIdentifier returns the Stream identifier associated to the stream.

pub async fn write(&self, data: &Bytes) -> Result<usize, Error>

Write writes len(p) bytes from p as binary data

pub async fn write_data_channel(
    &self,
    data: &Bytes,
    is_string: bool
) -> Result<usize, Error>

WriteDataChannel writes len(p) bytes from p

pub async fn close(&self) -> Result<(), Error>

Close closes the DataChannel and the underlying SCTP stream.

pub fn buffered_amount(&self) -> usize

BufferedAmount returns the number of bytes of data currently queued to be sent over this stream.

pub fn buffered_amount_low_threshold(&self) -> usize

BufferedAmountLowThreshold returns the number of bytes of buffered outgoing data that is considered “low.” Defaults to 0.

pub fn set_buffered_amount_low_threshold(&self, threshold: usize)

SetBufferedAmountLowThreshold is used to update the threshold. See BufferedAmountLowThreshold().

pub async fn on_buffered_amount_low(&self, f: OnBufferedAmountLowFn)

OnBufferedAmountLow sets the callback handler which would be called when the number of bytes of outgoing data buffered is lower than the threshold.

Trait Implementations

impl Clone for DataChannel

fn clone(&self) -> DataChannel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DataChannel

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

Formats the value using the given formatter.

impl Default for DataChannel

fn default() -> DataChannel

Returns the “default value” for a type.