Struct libp2p_core::muxing::StreamMuxerBox

pub struct StreamMuxerBox { /* fields omitted */ }

Abstract StreamMuxer.

Methods

impl StreamMuxerBox

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

Turns a stream muxer into a StreamMuxerBox.

Trait Implementations

impl StreamMuxer for StreamMuxerBox

type Substream = usize

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.

fn poll_inbound(&self) -> Poll<Option<Self::Substream>, IoError>

Polls for an inbound substream.

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

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

fn poll_outbound(
    &self,
    s: &mut Self::OutboundSubstream
) -> Poll<Option<Self::Substream>, IoError>

Polls the outbound substream.

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

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

fn read_substream(
    &self,
    s: &mut Self::Substream,
    buf: &mut [u8]
) -> Poll<usize, IoError>

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

fn write_substream(
    &self,
    s: &mut Self::Substream,
    buf: &[u8]
) -> Poll<usize, IoError>

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

fn flush_substream(&self, s: &mut Self::Substream) -> Poll<(), IoError>

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

fn shutdown_substream(
    &self,
    s: &mut Self::Substream,
    kind: Shutdown
) -> Poll<(), IoError>

Attempts to shut down a substream. The behaviour is similar to tokio_io::AsyncWrite::shutdown.

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

Destroys a substream.

fn shutdown(&self, kind: Shutdown) -> Poll<(), IoError>

Shutdown this StreamMuxer.

fn flush_all(&self) -> Poll<(), IoError>

Flush this StreamMuxer.