Struct webrtc_sctp::stream::Stream

pub struct Stream { /* fields omitted */ }

Stream represents an SCTP stream

Implementations

impl Stream

pub fn stream_identifier(&self) -> u16

stream_identifier returns the Stream identifier associated to the stream.

pub fn set_default_payload_type(
    &self,
    default_payload_type: PayloadProtocolIdentifier
)

set_default_payload_type sets the default payload type used by write.

pub fn set_reliability_params(
    &self,
    unordered: bool,
    rel_type: ReliabilityType,
    rel_val: u32
)

set_reliability_params sets reliability parameters for this stream.

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

read reads a packet of len(p) bytes, dropping the Payload Protocol Identifier. Returns EOF when the stream is reset or an error if the stream is closed otherwise.

pub async fn read_sctp(
    &self,
    p: &mut [u8]
) -> Result<(usize, PayloadProtocolIdentifier)>

read_sctp reads a packet of len(p) bytes and returns the associated Payload Protocol Identifier. Returns EOF when the stream is reset or an error if the stream is closed otherwise.

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

write writes len(p) bytes from p with the default Payload Protocol Identifier

pub async fn write_sctp(
    &self,
    p: &Bytes,
    ppi: PayloadProtocolIdentifier
) -> Result<usize>

write_sctp writes len(p) bytes from p to the DTLS connection

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

Close closes the write-direction of the stream. Future calls to write are not permitted after calling Close.

pub fn buffered_amount(&self) -> usize

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

pub fn buffered_amount_low_threshold(&self) -> usize

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

pub fn set_buffered_amount_low_threshold(&self, th: usize)

set_buffered_amount_low_threshold is used to update the threshold. See buffered_amount_low_threshold().

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

on_buffered_amount_low 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 Debug for Stream

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

Formats the value using the given formatter.

impl Default for Stream

fn default() -> Stream

Returns the “default value” for a type.