Struct libp2p_mplex::Multiplex

pub struct Multiplex<C> { /* private fields */ }

Multiplexer. Implements the StreamMuxer trait.

This implementation isn’t capable of detecting when the underlying socket changes its address, and no StreamMuxerEvent::AddressChange event is ever emitted.

Trait Implementations

impl<C> StreamMuxer for Multiplex<C> where
    C: AsyncRead + AsyncWrite + Unpin, 

type Substream = Substream

Type of the object that represents the raw substream where data can be read and written.

type OutboundSubstream = OutboundSubstream

Future that will be resolved when the outgoing substream is open.

type Error = Error

Error type of the muxer

fn poll_event(
    &self,
    cx: &mut Context<'_>
) -> Poll<Result<StreamMuxerEvent<Self::Substream>>>

Polls for a connection-wide event.

fn open_outbound(&self) -> Self::OutboundSubstream

Opens a new outgoing substream, and produces the equivalent to a future that will be resolved when it becomes available.

fn poll_outbound(
    &self,
    cx: &mut Context<'_>,
    _: &mut Self::OutboundSubstream
) -> Poll<Result<Self::Substream, Error>>

Polls the outbound substream.

fn destroy_outbound(&self, _substream: Self::OutboundSubstream)

Destroys an outbound substream future. Use this after the outbound substream has finished, or if you want to interrupt it.

fn read_substream(
    &self,
    cx: &mut Context<'_>,
    substream: &mut Self::Substream,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

Reads data from a substream. The behaviour is the same as futures::AsyncRead::poll_read.

fn write_substream(
    &self,
    cx: &mut Context<'_>,
    substream: &mut Self::Substream,
    buf: &[u8]
) -> Poll<Result<usize, Error>>

Write data to a substream. The behaviour is the same as futures::AsyncWrite::poll_write.

fn flush_substream(
    &self,
    cx: &mut Context<'_>,
    substream: &mut Self::Substream
) -> Poll<Result<(), Error>>

Flushes a substream. The behaviour is the same as futures::AsyncWrite::poll_flush.

fn shutdown_substream(
    &self,
    cx: &mut Context<'_>,
    substream: &mut Self::Substream
) -> Poll<Result<(), Error>>

Attempts to shut down the writing side of a substream. The behaviour is similar to AsyncWrite::poll_close.

fn destroy_substream(&self, sub: Self::Substream)

Destroys a substream.

fn poll_close(&self, cx: &mut Context<'_>) -> Poll<Result<(), Error>>

Closes this StreamMuxer.