Struct libp2p_core::muxing::StreamMuxerBox

pub struct StreamMuxerBox { /* private fields */ }

Abstract StreamMuxer.

Implementations

impl StreamMuxerBox

pub fn new<T>(muxer: T) -> StreamMuxerBoxwhere
    T: StreamMuxer + Send + Sync + 'static,
    T::OutboundSubstream: Send,
    T::Substream: Send + Unpin + 'static,
    T::Error: Send + Sync + 'static,

Turns a stream muxer into a StreamMuxerBox.

Trait Implementations

impl StreamMuxer for StreamMuxerBox

type Substream = SubstreamBox

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

type OutboundSubstream = usize

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>, Self::Error>>

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<'_>,
    s: &mut Self::OutboundSubstream
) -> Poll<Result<Self::Substream, Self::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 poll_close(&self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Closes this StreamMuxer.