Struct libp2prs_yamux::Yamux

pub struct Yamux<C: SplitEx> {
    pub la: Multiaddr,
    pub ra: Multiaddr,
    pub local_priv_key: Keypair,
    pub local_peer_id: PeerId,
    pub remote_pub_key: PublicKey,
    pub remote_peer_id: PeerId,
    // some fields omitted
}

A Yamux connection.

This implementation isn't capable of detecting when the underlying socket changes its address, and no [StreamMuxerEvent::AddressChange] event is ever emitted.

Fields

la: Multiaddr

The secure&connection info provided by underlying socket. The socket is moved into Connection, so we have to make a copy of these information

The local multiaddr of this connection

ra: Multiaddr

The remote multiaddr of this connection

local_priv_key: Keypair

The private key of the local

local_peer_id: PeerId

For convenience, the local peer ID, generated from local pub key

remote_pub_key: PublicKey

The public key of the remote.

remote_peer_id: PeerId

For convenience, put a PeerId here, which is actually calculated from remote_key

Implementations

impl<C: ConnectionInfo + SecureInfo + SplittableReadWrite> Yamux<C>

pub fn new(io: C, mut cfg: Config, mode: Mode) -> Self

Create a new Yamux connection.

Trait Implementations

impl<C: SplitEx> Clone for Yamux<C>

fn clone(&self) -> Self

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: SplitEx> ConnectionInfo for Yamux<C>

fn local_multiaddr(&self) -> Multiaddr

fn remote_multiaddr(&self) -> Multiaddr

impl<C: SplitEx> Debug for Yamux<C>

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

Formats the value using the given formatter.

impl<C: SplitEx> SecureInfo for Yamux<C>

fn local_peer(&self) -> PeerId

fn remote_peer(&self) -> PeerId

fn local_priv_key(&self) -> Keypair

fn remote_pub_key(&self) -> PublicKey

impl<C: SplittableReadWrite> StreamMuxer for Yamux<C>

fn open_stream<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<IReadWrite, TransportError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Opens a new outgoing substream.

fn accept_stream<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<IReadWrite, TransportError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Accepts a new incoming substream.

fn close<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<(), TransportError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Closes the stream muxer, the runtime of stream muxer will then exit.

fn task(&mut self) -> Option<BoxFuture<'static, ()>>

Returns a Future which represents the main loop of the stream muxer.

fn box_clone(&self) -> IStreamMuxer

Returns the cloned Trait object.

impl<C: SplittableReadWrite> StreamMuxerEx for Yamux<C>