Struct StreamMultiplexor

pub struct StreamMultiplexor<T> { /* private fields */ }

The Stream Multiplexor.

Implementations

impl<T: AsyncRead + AsyncWrite + Send + Unpin + 'static> StreamMultiplexor<T>

pub fn new(inner: T, config: StreamMultiplexorConfig) -> Self

Constructs a new StreamMultiplexor<T>.

pub fn new_paused(inner: T, config: StreamMultiplexorConfig) -> Self

Constructs a new paused StreamMultiplexor<T>.

This allows you to bind and listen on a bunch of ports before processing any packets from the inner stream, removing race conditions between bind and connect. Call start() to start processing the inner stream.

pub fn start(&self)

Start processing the inner stream.

Only effective on a paused StreamMultiplexor<T>. See new_paused(inner: T, config: StreamMultiplexorConfig).

pub fn close(&self)

Shut down the StreamMultiplexor instance and drop reference to the inner stream to close it.

pub async fn bind(&self, port: u16) -> Result<MuxListener<T>>

Bind to port and return a MuxListener<T>.

pub async fn connect(&self, port: u16) -> Result<DuplexStream>

Connect to port on the remote end.

pub fn watch_connected(&self) -> Receiver<bool>

Return a tokio::sync::watch::Receiver that will update to false when the inner stream closes.

Trait Implementations

impl<T> Debug for StreamMultiplexor<T>

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

Formats the value using the given formatter.

impl<T> Drop for StreamMultiplexor<T>

fn drop(&mut self)

Executes the destructor for this type.