Struct libp2p::core::transport::timeout::TransportTimeout
pub struct TransportTimeout<InnerTrans> { /* private fields */ }
Expand description
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>
impl<InnerTrans> TransportTimeout<InnerTrans>
pub fn new(trans: InnerTrans, timeout: Duration) -> 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>
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>
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,
impl<InnerTrans> Clone for TransportTimeout<InnerTrans>where
InnerTrans: Clone,
§fn clone(&self) -> TransportTimeout<InnerTrans>
fn clone(&self) -> TransportTimeout<InnerTrans>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read more§impl<InnerTrans> Debug for TransportTimeout<InnerTrans>where
InnerTrans: Debug,
impl<InnerTrans> Debug for TransportTimeout<InnerTrans>where
InnerTrans: Debug,
§impl<InnerTrans> Transport for TransportTimeout<InnerTrans>
impl<InnerTrans> Transport for TransportTimeout<InnerTrans>
§type Output = <InnerTrans as Transport>::Output
type Output = <InnerTrans as Transport>::Output
The result of a connection setup process, including protocol upgrades. Read more
§type Error = TransportTimeoutError<<InnerTrans as Transport>::Error>
type Error = TransportTimeoutError<<InnerTrans as Transport>::Error>
An error that occurred during connection setup.
§type ListenerUpgrade = Timeout<<InnerTrans as Transport>::ListenerUpgrade>
type ListenerUpgrade = Timeout<<InnerTrans as Transport>::ListenerUpgrade>
§fn listen_on(
&mut self,
id: ListenerId,
addr: Multiaddr
) -> Result<(), TransportError<<TransportTimeout<InnerTrans> as Transport>::Error>>
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
fn remove_listener(&mut self, id: ListenerId) -> bool
Remove a listener. Read more
§fn dial(
&mut self,
addr: Multiaddr
) -> Result<<TransportTimeout<InnerTrans> as Transport>::Dial, TransportError<<TransportTimeout<InnerTrans> as Transport>::Error>>
fn dial( &mut self, addr: Multiaddr ) -> Result<<TransportTimeout<InnerTrans> as Transport>::Dial, TransportError<<TransportTimeout<InnerTrans> as Transport>::Error>>
§fn dial_as_listener(
&mut self,
addr: Multiaddr
) -> Result<<TransportTimeout<InnerTrans> as Transport>::Dial, TransportError<<TransportTimeout<InnerTrans> as Transport>::Error>>
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. Read more§fn address_translation(
&self,
server: &Multiaddr,
observed: &Multiaddr
) -> Option<Multiaddr>
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. Read more§fn poll(
self: Pin<&mut TransportTimeout<InnerTrans>>,
cx: &mut Context<'_>
) -> Poll<TransportEvent<<TransportTimeout<InnerTrans> as Transport>::ListenerUpgrade, <TransportTimeout<InnerTrans> as Transport>::Error>>
fn poll( self: Pin<&mut TransportTimeout<InnerTrans>>, cx: &mut Context<'_> ) -> Poll<TransportEvent<<TransportTimeout<InnerTrans> as Transport>::ListenerUpgrade, <TransportTimeout<InnerTrans> as Transport>::Error>>
Poll for
TransportEvent
s. Read more§fn map<F, O>(self, f: F) -> Map<Self, F>
fn map<F, O>(self, f: F) -> Map<Self, F>
Applies a function on the connections created by the transport.
§fn map_err<F, E>(self, f: F) -> MapErr<Self, F>
fn map_err<F, E>(self, f: F) -> MapErr<Self, F>
Applies a function on the errors generated by the futures of the transport.
§fn or_transport<U>(self, other: U) -> OrTransport<Self, U>
fn or_transport<U>(self, other: U) -> OrTransport<Self, U>
Adds a fallback transport that is used when encountering errors
while establishing inbound or outbound connections. Read more
impl<InnerTrans> Copy for TransportTimeout<InnerTrans>where
InnerTrans: Copy,
impl<'pin, InnerTrans> Unpin for TransportTimeout<InnerTrans>where
__TransportTimeout<'pin, InnerTrans>: Unpin,
Auto Trait Implementations§
impl<InnerTrans> Freeze for TransportTimeout<InnerTrans>where
InnerTrans: Freeze,
impl<InnerTrans> RefUnwindSafe for TransportTimeout<InnerTrans>where
InnerTrans: RefUnwindSafe,
impl<InnerTrans> Send for TransportTimeout<InnerTrans>where
InnerTrans: Send,
impl<InnerTrans> Sync for TransportTimeout<InnerTrans>where
InnerTrans: Sync,
impl<InnerTrans> UnwindSafe for TransportTimeout<InnerTrans>where
InnerTrans: UnwindSafe,
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<TTransport> TransportExt for TTransportwhere
TTransport: Transport,
impl<TTransport> TransportExt for TTransportwhere
TTransport: Transport,
source§fn with_bandwidth_logging<S>(
self
) -> (Boxed<(PeerId, StreamMuxerBox)>, Arc<BandwidthSinks>)
fn with_bandwidth_logging<S>( self ) -> (Boxed<(PeerId, StreamMuxerBox)>, Arc<BandwidthSinks>)
👎Deprecated: Use
libp2p::SwarmBuilder::with_bandwidth_metrics
or libp2p_metrics::BandwidthTransport
instead.Adds a layer on the
Transport
that logs all traffic that passes through the streams
created by it. Read more