Struct libp2p_core::transport::upgrade::Multiplexed

pub struct Multiplexed<T>(_);

A authenticated and multiplexed transport, obtained from Authenticated::multiplex.

Implementations

impl<T> Multiplexed<T>

pub fn boxed<M>(self) -> Boxed<(PeerId, StreamMuxerBox)>where
    T: Transport<Output = (PeerId, M)> + Sized + Send + Unpin + 'static,
    T::Dial: Send + 'static,
    T::ListenerUpgrade: Send + 'static,
    T::Error: Send + Sync,
    M: StreamMuxer + Send + Sync + 'static,
    M::Substream: Send + Unpin + 'static,
    M::OutboundSubstream: Send + 'static,
    M::Error: Send + Sync + 'static,

Boxes the authenticated, multiplexed transport, including the StreamMuxer and custom transport errors.

pub fn timeout(self, timeout: Duration) -> Multiplexed<TransportTimeout<T>>

Adds a timeout to the setup and protocol upgrade process for all inbound and outbound connections established through the transport.

pub fn outbound_timeout(
    self,
    timeout: Duration
) -> Multiplexed<TransportTimeout<T>>

Adds a timeout to the setup and protocol upgrade process for all outbound connections established through the transport.

pub fn inbound_timeout(
    self,
    timeout: Duration
) -> Multiplexed<TransportTimeout<T>>

Adds a timeout to the setup and protocol upgrade process for all inbound connections established through the transport.

Trait Implementations

impl<T: Clone> Clone for Multiplexed<T>

fn clone(&self) -> Multiplexed<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Transport for Multiplexed<T>where
    T: Transport,

type Output = <T as Transport>::Output

The result of a connection setup process, including protocol upgrades.

type Error = <T as Transport>::Error

An error that occurred during connection setup.

type ListenerUpgrade = <T as Transport>::ListenerUpgrade

A pending Output for an inbound connection, obtained from the Transport stream.

type Dial = <T as Transport>::Dial

A pending Output for an outbound connection, obtained from dialing.

fn dial(
    &mut self,
    addr: Multiaddr
) -> Result<Self::Dial, TransportError<Self::Error>>

Dials the given Multiaddr, returning a future for a pending outbound connection.

fn remove_listener(&mut self, id: ListenerId) -> bool

Remove a listener.

fn dial_as_listener(
    &mut self,
    addr: Multiaddr
) -> Result<Self::Dial, TransportError<Self::Error>>

As Transport::dial but has the local node act as a listener on the outgoing connection.

fn listen_on(
    &mut self,
    addr: Multiaddr
) -> Result<ListenerId, TransportError<Self::Error>>

Listens on the given Multiaddr for inbound connections.

fn address_translation(
    &self,
    server: &Multiaddr,
    observed: &Multiaddr
) -> Option<Multiaddr>

Performs a transport-specific mapping of an address observed by a remote onto a local listen address to yield an address for the local node that may be reachable for other peers.

fn poll(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<TransportEvent<Self::ListenerUpgrade, Self::Error>>

Poll for TransportEvents.

fn map<F, O>(self, f: F) -> Map<Self, F>where
    Self: Sized,
    F: FnOnce(Self::Output, ConnectedPoint) -> O,

Applies a function on the connections created by the transport.

fn map_err<F, E>(self, f: F) -> MapErr<Self, F>where
    Self: Sized,
    F: FnOnce(Self::Error) -> E,

Applies a function on the errors generated by the futures of the transport.

fn or_transport<U>(self, other: U) -> OrTransport<Self, U>where
    Self: Sized,
    U: Transport,
    <U as Transport>::Error: 'static,

Adds a fallback transport that is used when encountering errors while establishing inbound or outbound connections.

fn and_then<C, F, O>(self, f: C) -> AndThen<Self, C>where
    Self: Sized,
    C: FnOnce(Self::Output, ConnectedPoint) -> F,
    F: TryFuture<Ok = O>,
    <F as TryFuture>::Error: Error + 'static,

Applies a function producing an asynchronous result to every connection created by this transport.

fn upgrade(self, version: Version) -> Builder<Self>where
    Self: Sized,
    Self::Error: 'static,

Begins a series of protocol upgrades via an upgrade::Builder.

impl<'pin, T> Unpin for Multiplexed<T>where
    __Multiplexed<'pin, T>: Unpin,