Struct libp2p_core::transport::timeout::TransportTimeout

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

Wraps around a Transport and adds a timeout to all the incoming and outgoing connections.

The timeout includes the upgrade. There is no timeout on the listener or on stream of incoming substreams.

Methods

impl<InnerTrans> TransportTimeout<InnerTrans>

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

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

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

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

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

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

Trait Implementations

impl<InnerTrans> Transport for TransportTimeout<InnerTrans> where     InnerTrans: Transport,     InnerTrans::Error: 'static,

type Output = InnerTrans::Output

The raw connection to a peer.

type Error = TransportTimeoutError<InnerTrans::Error>

Error that can happen when dialing or listening.

type Listener = TimeoutListener<InnerTrans::Listener>

The listener produces incoming connections.

type ListenerUpgrade = TokioTimerMapErr<Timeout<InnerTrans::ListenerUpgrade>>

After a connection has been received, we may need to do some asynchronous pre-processing on it (e.g. an intermediary protocol negotiation). While this pre-processing takes place, we want to be able to continue polling on the listener.

type Dial = TokioTimerMapErr<Timeout<InnerTrans::Dial>>

A future which indicates that we are currently dialing to a peer.

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

Listen on the given multiaddr. Returns a stream of incoming connections, plus a modified version of the Multiaddr. This new Multiaddr is the one that that should be advertised to other nodes, instead of the one passed as parameter.

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

Dial the given multi-addr.

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

Takes a multiaddress we're listening on (server), and tries to convert it to an externally-visible multiaddress. In order to do so, we pass an observed address which a remote node observes for one of our dialers.

fn boxed(self) -> Boxed<Self::Output, Self::Error> where     Self: Sized + Clone + Send + Sync + 'static,     Self::Dial: Send + 'static,     Self::Listener: Send + 'static,     Self::ListenerUpgrade: Send + 'static,

Turns this Transport into an abstract boxed transport.

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

Applies a function on the output of the Transport.

fn map_err<F, TNewErr>(self, map_err: F) -> MapErr<Self, F> where     Self: Sized,     F: FnOnce(Self::Error) -> TNewErr + Clone,

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

fn or_transport<T>(self, other: T) -> OrTransport<Self, T> where     Self: Sized,

Builds a new struct that implements Transport that contains both self and other.

fn with_upgrade<U, O, E>(self, upgrade: U) -> Upgrade<Self, U> where     Self: Sized,     Self::Output: AsyncRead + AsyncWrite,     U: InboundUpgrade<Self::Output, Output = O, Error = E>,     U: OutboundUpgrade<Self::Output, Output = O, Error = E>,

Wraps this transport inside an upgrade. Whenever a connection that uses this transport is established, it is wrapped inside the upgrade.

fn and_then<C, F, O>(self, upgrade: C) -> AndThen<Self, C> where     Self: Sized,     C: FnOnce(Self::Output, ConnectedPoint) -> F + Clone,     F: IntoFuture<Item = O>,

Wraps this transport inside an upgrade. Whenever a connection that uses this transport is established, it is wrapped inside the upgrade.

fn with_timeout(self, timeout: Duration) -> TransportTimeout<Self> where     Self: Sized,

Adds a timeout to the connection and upgrade steps for all the sockets created by the transport.

fn with_outbound_timeout(self, timeout: Duration) -> TransportTimeout<Self> where     Self: Sized,

Adds a timeout to the connection and upgrade steps for all the outgoing sockets created by the transport.

fn with_inbound_timeout(self, timeout: Duration) -> TransportTimeout<Self> where     Self: Sized,

Adds a timeout to the connection and upgrade steps for all the incoming sockets created by the transport.

impl<InnerTrans: Copy> Copy for TransportTimeout<InnerTrans>

impl<InnerTrans: Clone> Clone for TransportTimeout<InnerTrans>

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> Debug for TransportTimeout<InnerTrans>

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

Formats the value using the given formatter.