Struct libp2p::core::muxing::SingletonMuxer

pub struct SingletonMuxer<TSocket> { /* fields omitted */ }

Implementation of StreamMuxer that allows only one substream on top of a connection, yielding the connection itself.

Applying this muxer on a connection doesn’t read or write any data on the connection itself. Most notably, no protocol is negotiated.

Implementations

impl<TSocket> SingletonMuxer<TSocket>

pub fn new(inner: TSocket, endpoint: Endpoint) -> SingletonMuxer<TSocket>

Creates a new SingletonMuxer.

If endpoint is Dialer, then only one outbound substream will be permitted. If endpoint is Listener, then only one inbound substream will be permitted.

Trait Implementations

impl<TSocket> StreamMuxer for SingletonMuxer<TSocket> where
    TSocket: 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

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

Polls for a connection-wide event.

pub fn open_outbound(
    &self
) -> <SingletonMuxer<TSocket> 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,
    &mut Context<'_>,
    &mut <SingletonMuxer<TSocket> as StreamMuxer>::OutboundSubstream
) -> Poll<Result<<SingletonMuxer<TSocket> as StreamMuxer>::Substream, Error>>

Polls the outbound substream.

pub fn destroy_outbound(
    &self,
    <SingletonMuxer<TSocket> 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<'_>,
    &mut <SingletonMuxer<TSocket> as StreamMuxer>::Substream,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

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

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

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

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

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

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

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

pub fn destroy_substream(
    &self,
    <SingletonMuxer<TSocket> as StreamMuxer>::Substream
)

Destroys a substream.

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

Closes this StreamMuxer.

pub fn flush_all(&self, cx: &mut Context<'_>) -> Poll<Result<(), 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.