Struct libp2p_core::muxing::SingletonMuxer

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

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) -> Self

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 = TSocket

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

type Error = Error

Error type of the muxer

fn poll_inbound(
    self: Pin<&mut Self>,
    _: &mut Context<'_>
) -> Poll<Result<Self::Substream, Self::Error>>

Poll for new inbound substreams.

fn poll_outbound(
    self: Pin<&mut Self>,
    _: &mut Context<'_>
) -> Poll<Result<Self::Substream, Self::Error>>

Poll for a new, outbound substream.

fn poll_close(
    self: Pin<&mut Self>,
    _cx: &mut Context<'_>
) -> Poll<Result<(), Error>>

Poll to close this StreamMuxer.

fn poll(
    self: Pin<&mut Self>,
    _: &mut Context<'_>
) -> Poll<Result<StreamMuxerEvent, Self::Error>>

Poll to allow the underlying connection to make progress.