Struct sctp_proto::Stream

pub struct Stream<'a> { /* fields omitted */ }

Stream represents an SCTP stream

Implementations

impl<'a> Stream<'a>

pub fn read(&mut self) -> Result<Option<Chunks>, Error>

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 fn read_sctp(&mut self) -> Result<Option<Chunks>, Error>

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 fn write(&mut self, p: &Bytes) -> Result<usize, Error>

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

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

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

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

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

Methods from Deref<Target = StreamState>

pub fn stream_identifier(&self) -> u16

stream_identifier returns the Stream identifier associated to the stream.

pub fn set_default_payload_type(
    &mut self,
    default_payload_type: PayloadProtocolIdentifier
)

set_default_payload_type sets the default payload type used by write.

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

set_reliability_params sets reliability parameters for this stream.

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(&mut self, th: usize)

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

Trait Implementations

impl<'a> Deref for Stream<'a>

type Target = StreamState

The resulting type after dereferencing.

fn deref(&self) -> &StreamState

Dereferences the value.

impl<'a> DerefMut for Stream<'a>

fn deref_mut(&mut self) -> &mut StreamState

Mutably dereferences the value.