Struct libp2p::tcp::TcpConfig

pub struct TcpConfig { /* fields omitted */ }

Represents the configuration for a TCP/IP transport capability for libp2p.

The TCP sockets created by libp2p will need to be progressed by running the futures and streams obtained by libp2p through the tokio reactor.

Implementations

impl TcpConfig

pub fn new() -> TcpConfig

Creates a new configuration object for TCP/IP.

pub fn ttl(self, value: u32) -> TcpConfig

Sets the TTL to set for opened sockets.

pub fn nodelay(self, value: bool) -> TcpConfig

Sets the TCP_NODELAY to set for opened sockets.

Trait Implementations

impl Clone for TcpConfig

fn clone(&self) -> TcpConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TcpConfig

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

Formats the value using the given formatter.

impl Default for TcpConfig

fn default() -> TcpConfig

Returns the "default value" for a type.

impl Transport for TcpConfig

type Output = TcpTransStream

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

type Error = Error

An error that occurred during connection setup.

type Listener = Pin<Box<dyn Stream<Item = Result<ListenerEvent<<TcpConfig as Transport>::ListenerUpgrade, <TcpConfig as Transport>::Error>, <TcpConfig as Transport>::Error>> + 'static + Send>>

A stream of Outputs for inbound connections.

type ListenerUpgrade = Ready<Result<<TcpConfig as Transport>::Output, <TcpConfig as Transport>::Error>>

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

type Dial = Pin<Box<dyn Future<Output = Result<TcpTransStream, Error>> + 'static + Send>>

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

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

Listens on the given Multiaddr, producing a stream of pending, inbound connections and addresses this transport is listening on (cf. ListenerEvent).

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

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

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

Turns the transport into an abstract boxed (i.e. heap-allocated) transport.

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

Applies a function on the connections created by the transport.

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

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

fn or_transport<U>(self, other: U) -> OrTransport<Self, U> where
    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
    C: FnOnce(Self::Output, ConnectedPoint) -> F + Clone,
    F: TryFuture<Ok = O>,
    <F as TryFuture>::Error: Error,
    <F as TryFuture>::Error: 'static, 

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

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.

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.

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.

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

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