Struct libp2p_quic::QuicMuxer

pub struct QuicMuxer { /* fields omitted */ }

State for a single opened QUIC connection.

Implementations

impl QuicMuxer

pub fn new(
    endpoint: ConnectionChannel,
    connection: Connection<NoiseSession>
) -> Self

pub fn is_handshaking(&self) -> bool

pub fn peer_id(&self) -> PeerId

pub fn local_addr(&self) -> Multiaddr

pub fn remote_addr(&self) -> Multiaddr

Trait Implementations

impl Debug for QuicMuxer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl StreamMuxer for QuicMuxer

type Substream = StreamId

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

type OutboundSubstream = ()

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

type Error = QuicMuxerError

Error type of the muxer

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

Polls for a connection-wide event.

fn open_outbound(&self) -> Self::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,
    cx: &mut Context<'_>,
    _: &mut Self::OutboundSubstream
) -> Poll<Result<Self::Substream, Self::Error>>

Polls the outbound substream.

fn destroy_outbound(&self, _: Self::OutboundSubstream)

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

fn read_substream(
    &self,
    cx: &mut Context<'_>,
    id: &mut Self::Substream,
    buf: &mut [u8]
) -> Poll<Result<usize, Self::Error>>

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

fn write_substream(
    &self,
    cx: &mut Context<'_>,
    id: &mut Self::Substream,
    buf: &[u8]
) -> Poll<Result<usize, Self::Error>>

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

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

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

fn destroy_substream(&self, id: Self::Substream)

Destroys a substream.

fn flush_substream(
    &self,
    _cx: &mut Context<'_>,
    _id: &mut Self::Substream
) -> Poll<Result<(), Self::Error>>

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

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

Flush this StreamMuxer.

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

Closes this StreamMuxer.

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.