Struct libp2p::yamux::Yamux

pub struct Yamux<C>(_, _);

Methods

impl<C> Yamux<C> where
    C: AsyncRead + AsyncWrite + 'static, 

pub fn new(c: C, cfg: Config, mode: Mode) -> Yamux<C>

Trait Implementations

impl<C> StreamMuxer for Yamux<C> where
    C: AsyncRead + AsyncWrite + 'static, 

type Substream = StreamHandle<C>

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

type OutboundSubstream = FutureResult<Option<<Yamux<C> as StreamMuxer>::Substream>, Error>

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

type Error = Error

Error type of the muxer

fn poll_inbound(
    &self
) -> Result<Async<<Yamux<C> as StreamMuxer>::Substream>, Error>

Polls for an inbound substream.

fn open_outbound(&self) -> <Yamux<C> as StreamMuxer>::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,
    substream: &mut <Yamux<C> as StreamMuxer>::OutboundSubstream
) -> Result<Async<<Yamux<C> as StreamMuxer>::Substream>, Error>

Polls the outbound substream.

fn destroy_outbound(&self, <Yamux<C> as StreamMuxer>::OutboundSubstream)

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

unsafe fn prepare_uninitialized_buffer(&self, &mut [u8]) -> bool

Mimics the prepare_uninitialized_buffer method of the AsyncRead trait.

fn read_substream(
    &self,
    sub: &mut <Yamux<C> as StreamMuxer>::Substream,
    buf: &mut [u8]
) -> Result<Async<usize>, Error>

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

fn write_substream(
    &self,
    sub: &mut <Yamux<C> as StreamMuxer>::Substream,
    buf: &[u8]
) -> Result<Async<usize>, Error>

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

fn flush_substream(
    &self,
    sub: &mut <Yamux<C> as StreamMuxer>::Substream
) -> Result<Async<()>, Error>

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

fn shutdown_substream(
    &self,
    sub: &mut <Yamux<C> as StreamMuxer>::Substream
) -> Result<Async<()>, Error>

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

fn destroy_substream(&self, <Yamux<C> as StreamMuxer>::Substream)

Destroys a substream.

fn is_remote_acknowledged(&self) -> bool

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

fn close(&self) -> Result<Async<()>, Error>

Closes this StreamMuxer.

fn flush_all(&self) -> Result<Async<()>, Error>

Flush this StreamMuxer.