Struct libp2p::core::muxing::StreamMuxerBox

pub struct StreamMuxerBox { /* fields omitted */ }

Abstract StreamMuxer.

Implementations

impl StreamMuxerBox

pub fn new<T>(muxer: T) -> StreamMuxerBox where
    T: StreamMuxer + Send + Sync + 'static,
    <T as StreamMuxer>::OutboundSubstream: Send,
    <T as StreamMuxer>::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.

type Error = Error

Error type of the muxer

pub fn poll_event(
    &self,
    cx: &mut Context<'_>
) -> Poll<Result<StreamMuxerEvent<<StreamMuxerBox as StreamMuxer>::Substream>, <StreamMuxerBox as StreamMuxer>::Error>>

Polls for a connection-wide event.

pub fn open_outbound(
    &self
) -> <StreamMuxerBox as StreamMuxer>::OutboundSubstream

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

pub fn poll_outbound(
    &self,
    cx: &mut Context<'_>,
    s: &mut <StreamMuxerBox as StreamMuxer>::OutboundSubstream
) -> Poll<Result<<StreamMuxerBox as StreamMuxer>::Substream, <StreamMuxerBox as StreamMuxer>::Error>>

Polls the outbound substream.

pub fn destroy_outbound(
    &self,
    substream: <StreamMuxerBox as StreamMuxer>::OutboundSubstream
)

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

pub fn read_substream(
    &self,
    cx: &mut Context<'_>,
    s: &mut <StreamMuxerBox as StreamMuxer>::Substream,
    buf: &mut [u8]
) -> Poll<Result<usize, <StreamMuxerBox as StreamMuxer>::Error>>

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

pub fn write_substream(
    &self,
    cx: &mut Context<'_>,
    s: &mut <StreamMuxerBox as StreamMuxer>::Substream,
    buf: &[u8]
) -> Poll<Result<usize, <StreamMuxerBox as StreamMuxer>::Error>>

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

pub fn flush_substream(
    &self,
    cx: &mut Context<'_>,
    s: &mut <StreamMuxerBox as StreamMuxer>::Substream
) -> Poll<Result<(), <StreamMuxerBox as StreamMuxer>::Error>>

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

pub fn shutdown_substream(
    &self,
    cx: &mut Context<'_>,
    s: &mut <StreamMuxerBox as StreamMuxer>::Substream
) -> Poll<Result<(), <StreamMuxerBox as StreamMuxer>::Error>>

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

pub fn destroy_substream(&self, s: <StreamMuxerBox as StreamMuxer>::Substream)

Destroys a substream.

pub fn close(
    &self,
    cx: &mut Context<'_>
) -> Poll<Result<(), <StreamMuxerBox as StreamMuxer>::Error>>

Closes this StreamMuxer.

pub fn flush_all(
    &self,
    cx: &mut Context<'_>
) -> Poll<Result<(), <StreamMuxerBox as StreamMuxer>::Error>>

Flush this StreamMuxer.

pub fn is_remote_acknowledged(&self) -> bool

👎 Deprecated:

This method is unused and will be removed in the future

Returns true if the remote has shown any sign of activity after the muxer has been open.