Struct penguin_mux::Multiplexor

pub struct Multiplexor<S> { /* private fields */ }

A multiplexor over a WebSocket connection.

Implementations

impl<S: WebSocketStream> Multiplexor<S>

pub fn new( ws: S, role: Role, keepalive_interval: Option<Duration>, task_joinset: Option<&mut JoinSet<Result<()>>> ) -> Self

Create a new Multiplexor.

Arguments

• ws: The WebSocket connection to multiplex over.

• role: The role of this side of the connection. (does not have to match the WebSocket role)

• keepalive_interval: The interval at which to send Ping frames.

• task_joinset: A JoinSet to spawn the multiplexor task into so that the caller can notice if the task exits. If it is None, the task will be spawned by tokio::spawn and errors will be logged.

pub async fn client_new_stream_channel( &self, host: &[u8], port: u16 ) -> Result<MuxStream<S>>

Request a channel for host and port.

Arguments

• host: The host to forward to. While the current implementation supports a domain of arbitrary length, Section 3.2.2 of RFC 3986 specifies that the host component of a URI is limited to 255 octets.
• port: The port to forward to.

Panics

Panics if the Multiplexor is not a client.

Cancel safety

This function is not cancel safe. If the task is cancelled while waiting for the channel to be established, that channel may be established but inaccessible through normal means. Subsequent calls to this function will result in a new channel being established.

pub async fn server_new_stream_channel(&self) -> Result<MuxStream<S>>

Get the next available stream channel.

Errors

Returns Error::Closed if the connection is closed.

Panics

Panics if the Multiplexor is not a server.

Cancel Safety

This function is cancel safe. If the task is cancelled while waiting for a new connection, it is guaranteed that no connected stream will be lost.

pub async fn get_datagram(&self) -> Result<DatagramFrame>

Get the next available datagram.

Errors

Returns Error::Closed if the connection is closed.

Cancel Safety

This function is cancel safe. If the task is cancelled while waiting for a datagram, it is guaranteed that no datagram will be lost.

pub async fn send_datagram(&self, frame: DatagramFrame) -> Result<()>

Send a datagram

Errors

• Returns Error::DatagramHostTooLong if the destination host is longer than 255 octets.
• Returns Error::SendDatagram if the datagram could not be sent due to a crate::ws::Error.

Cancel Safety

This function is cancel safe. If the task is cancelled, it is guaranteed that the datagram has not been sent.

Trait Implementations

impl<S: Debug> Debug for Multiplexor<S>

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

Formats the value using the given formatter.

impl<S> Drop for Multiplexor<S>

fn drop(&mut self)

Executes the destructor for this type.