Struct libp2p::core::transport::timeout::TransportTimeout

pub struct TransportTimeout<InnerTrans> { /* private fields */ }

A TransportTimeout is a Transport that wraps another Transport and adds timeouts to all inbound and outbound connection attempts.

Note: listen_on is never subject to a timeout, only the setup of each individual accepted connection.

Implementations

impl<InnerTrans> TransportTimeout<InnerTrans>

pub fn new(trans: InnerTrans, timeout: Duration) -> TransportTimeout<InnerTrans>

Wraps around a Transport to add timeouts to all the sockets created by it.

pub fn with_outgoing_timeout( trans: InnerTrans, timeout: Duration, ) -> TransportTimeout<InnerTrans>

Wraps around a Transport to add timeouts to the outgoing connections.

pub fn with_ingoing_timeout( trans: InnerTrans, timeout: Duration, ) -> TransportTimeout<InnerTrans>

Wraps around a Transport to add timeouts to the ingoing connections.

Trait Implementations

impl<InnerTrans> Clone for TransportTimeout<InnerTrans>

where InnerTrans: Clone,

fn clone(&self) -> TransportTimeout<InnerTrans>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<InnerTrans> Debug for TransportTimeout<InnerTrans>

where InnerTrans: Debug,

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

Formats the value using the given formatter.

impl<InnerTrans> Transport for TransportTimeout<InnerTrans>

where InnerTrans: Transport, <InnerTrans as Transport>::Error: 'static,

type Output = <InnerTrans as Transport>::Output

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

type Error = TransportTimeoutError<<InnerTrans as Transport>::Error>

An error that occurred during connection setup.

type ListenerUpgrade = Timeout<<InnerTrans as Transport>::ListenerUpgrade>

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

type Dial = Timeout<<InnerTrans as Transport>::Dial>

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

fn listen_on( &mut self, id: ListenerId, addr: Multiaddr, ) -> Result<(), TransportError<<TransportTimeout<InnerTrans> as Transport>::Error>>

Listens on the given Multiaddr for inbound connections with a provided ListenerId.

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

Remove a listener.

fn dial( &mut self, addr: Multiaddr, ) -> Result<<TransportTimeout<InnerTrans> as Transport>::Dial, TransportError<<TransportTimeout<InnerTrans> as Transport>::Error>>

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

fn dial_as_listener( &mut self, addr: Multiaddr, ) -> Result<<TransportTimeout<InnerTrans> as Transport>::Dial, TransportError<<TransportTimeout<InnerTrans> as Transport>::Error>>

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

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 TransportTimeout<InnerTrans>>, cx: &mut Context<'_>, ) -> Poll<TransportEvent<<TransportTimeout<InnerTrans> as Transport>::ListenerUpgrade, <TransportTimeout<InnerTrans> as Transport>::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<InnerTrans> Copy for TransportTimeout<InnerTrans>

where InnerTrans: Copy,

impl<'pin, InnerTrans> Unpin for TransportTimeout<InnerTrans>

where __TransportTimeout<'pin, InnerTrans>: Unpin,