Struct libp2p_core::muxing::SingletonMuxer [−][src]
pub struct SingletonMuxer<TSocket> { /* fields omitted */ }
Expand description
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
Trait Implementations
impl<TSocket> StreamMuxer for SingletonMuxer<TSocket> where
TSocket: AsyncRead + AsyncWrite + Unpin,
impl<TSocket> StreamMuxer for SingletonMuxer<TSocket> where
TSocket: AsyncRead + AsyncWrite + Unpin,
type Substream = Substream
type Substream = Substream
Type of the object that represents the raw substream where data can be read and written.
type OutboundSubstream = OutboundSubstream
type OutboundSubstream = OutboundSubstream
Future that will be resolved when the outgoing substream is open.
fn poll_event(
&self,
_: &mut Context<'_>
) -> Poll<Result<StreamMuxerEvent<Self::Substream>, Error>>
fn poll_event(
&self,
_: &mut Context<'_>
) -> Poll<Result<StreamMuxerEvent<Self::Substream>, Error>>
Polls for a connection-wide event. Read more
Opens a new outgoing substream, and produces the equivalent to a future that will be resolved when it becomes available. Read more
fn poll_outbound(
&self,
_: &mut Context<'_>,
_: &mut Self::OutboundSubstream
) -> Poll<Result<Self::Substream, Error>>
fn poll_outbound(
&self,
_: &mut Context<'_>,
_: &mut Self::OutboundSubstream
) -> Poll<Result<Self::Substream, Error>>
Polls the outbound substream. Read more
Destroys an outbound substream future. Use this after the outbound substream has finished, or if you want to interrupt it. Read more
Reads data from a substream. The behaviour is the same as futures::AsyncRead::poll_read
. Read more
Write data to a substream. The behaviour is the same as futures::AsyncWrite::poll_write
. Read more
Flushes a substream. The behaviour is the same as futures::AsyncWrite::poll_flush
. Read more
Attempts to shut down the writing side of a substream. The behaviour is similar to
AsyncWrite::poll_close
. Read more
Destroys a substream.
Closes this StreamMuxer
. Read more
Flush this StreamMuxer
. Read more
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. Read more
Auto Trait Implementations
impl<TSocket> !RefUnwindSafe for SingletonMuxer<TSocket>
impl<TSocket> Send for SingletonMuxer<TSocket> where
TSocket: Send,
impl<TSocket> Sync for SingletonMuxer<TSocket> where
TSocket: Send,
impl<TSocket> Unpin for SingletonMuxer<TSocket> where
TSocket: Unpin,
impl<TSocket> UnwindSafe for SingletonMuxer<TSocket> where
TSocket: UnwindSafe,