Struct libp2p_rs::core::transport::timeout::TransportTimeout

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

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, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<InnerTrans> Debug for TransportTimeout<InnerTrans> where
    InnerTrans: Debug, 

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

Formats the value using the given formatter.

impl<InnerTrans> Transport for TransportTimeout<InnerTrans> where
    InnerTrans: Transport + Clone + 'static,
    <InnerTrans as Transport>::Output: ConnectionInfo,
    <InnerTrans as Transport>::Output: 'static, 

type Output = <InnerTrans as Transport>::Output

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

pub fn listen_on(
    &mut self,
    addr: Multiaddr
) -> Result<Box<dyn TransportListener<Output = <TransportTimeout<InnerTrans> as Transport>::Output> + 'static + Send, Global>, TransportError>

Creates a IListener with timeout parameter, which will be used for Ilistener to accept new connections.

pub fn dial<'life0, 'async_trait>(
    &'life0 mut self,
    addr: Multiaddr
) -> Pin<Box<dyn Future<Output = Result<<TransportTimeout<InnerTrans> as Transport>::Output, TransportError>> + 'async_trait + Send, Global>> where
    'life0: 'async_trait,
    TransportTimeout<InnerTrans>: 'async_trait, 

Creates a new outgoing connection, with the specified timeout parameter.

pub fn box_clone(
    &self
) -> Box<dyn Transport<Output = <TransportTimeout<InnerTrans> as Transport>::Output> + 'static + Send, Global>

Clones the transport and returns the trait object.

pub fn protocols(&self) -> Vec<u32, Global>

Returns the Multiaddr protocol supported by the transport.

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

Adds a timeout to the connection setup (including upgrades) for all inbound and outbound connections established through the transport.

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

Adds a timeout to the connection setup (including upgrades) for all outbound connections established through the transport.

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

Adds a timeout to the connection setup (including upgrades) for all inbound connections established through the transport.