Struct DataChannel 

pub struct DataChannel { /* private fields */ }

DataChannel represents a data channel

Implementations

impl DataChannel

pub fn dial( config: DataChannelConfig, association_handle: usize, stream_id: u16, ) -> Result<Self>

Dial opens a data channels over SCTP

pub fn accept( config: DataChannelConfig, association_handle: usize, stream_id: u16, ppi: PayloadProtocolIdentifier, buf: &[u8], ) -> Result<Self>

Accept is used to accept incoming data channels over SCTP

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 association_handle(&self) -> usize

association_handle returns the association handle

pub fn stream_identifier(&self) -> u16

StreamIdentifier returns the Stream identifier associated to the stream.

pub fn config(&self) -> &DataChannelConfig

The configuration this channel was opened with.

pub fn set_buffered_amount_high_threshold( &mut self, threshold: u32, ) -> Result<()>

SetBufferedAmountHighThreshold is used to update the threshold. See BufferedAmountHighThreshold().

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

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

pub fn get_reliability_params( channel_type: ChannelType, ) -> (bool, ReliabilityType)

Decomposes a ChannelType into the SCTP send parameters it implies.

Returns whether delivery is unordered, together with the reliability type and value SCTP needs for partial reliability.

pub fn get_channel_type_and_reliability_parameter( ordered: bool, max_retransmits: Option<u16>, max_packet_life_time: Option<u16>, ) -> (ChannelType, u32)

Derives the ChannelType and reliability parameter from the maxPacketLifeTime / maxRetransmits pair the W3C API exposes.

The two are mutually exclusive; supplying neither yields a fully reliable channel.

pub fn get_data_channel_message( is_string: bool, data: BytesMut, ) -> DataChannelMessage

Builds the payload protocol identifier and payload for a user message.

Empty messages get their own identifiers (StringEmpty/BinaryEmpty) because SCTP cannot carry a zero-length payload.

Trait Implementations

impl Clone for DataChannel

fn clone(&self) -> DataChannel

Returns a duplicate 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.

impl Protocol<DataChannelMessage, DataChannelMessage, ()> for DataChannel

fn handle_read(&mut self, msg: DataChannelMessage) -> Result<()>

ReadDataChannel reads a packet of len(p) bytes. It returns the number of bytes read and true if the data read is a string.

fn handle_write(&mut self, msg: DataChannelMessage) -> Result<()>

handle_write writes len(p) bytes from p

fn poll_write(&mut self) -> Option<DataChannelMessage>

Returns packets to transmit

fn close(&mut self) -> Result<()>

Close closes the DataChannel and the underlying SCTP stream.

type Rout = DataChannelMessage

Output read message type

type Wout = DataChannelMessage

Output write message type

type Eout = ()

Output event type

type Error = Error

Error type for protocol operations

type Time = ()

Time/Instant type for timeout handling

fn poll_read(&mut self) -> Option<DataChannelMessage>

Poll for a processed read message.

fn handle_event(&mut self, _evt: Ein) -> Result<(), Self::Error>

Handle a custom event.

fn poll_event(&mut self) -> Option<Self::Eout>

Poll for a generated event.

fn handle_timeout(&mut self, _now: Self::Time) -> Result<(), Self::Error>

Handle a timeout event.

fn poll_timeout(&mut self) -> Option<Self::Time>

Poll for the next timeout deadline.