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.

Methods

impl TcpConfig

pub fn new() -> TcpConfig

Creates a new configuration object for TCP/IP.

pub fn recv_buffer_size(self, value: usize) -> Self

Sets the size of the recv buffer size to set for opened sockets.

pub fn send_buffer_size(self, value: usize) -> Self

Sets the size of the send buffer size to set for opened sockets.

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

Sets the TTL to set for opened sockets.

pub fn keepalive(self, value: Option<Duration>) -> Self

Sets the keep alive pinging duration to set for opened sockets.

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

Sets the TCP_NODELAY to set for opened sockets.

Trait Implementations

impl Default for TcpConfig

fn default() -> TcpConfig

Returns the "default value" for a type.

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

Formats the value using the given formatter.

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 = TcpListener

A stream of Outputs for inbound connections.

type ListenerUpgrade = FutureResult<Self::Output, Self::Error>

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

type Dial = TcpDialFut

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

fn listen_on(
    self,
    addr: Multiaddr
) -> Result<Self::Listener, TransportError<Self::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<Self::Dial, TransportError<Self::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 this Transport into an abstract boxed transport.

fn map<F, O>(self, map: 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, TNewErr>(self, map_err: F) -> MapErr<Self, F> where
    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>

Builds a new transport that falls back to another transport when encountering errors on dialing or listening for connections.

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

Wraps this transport inside an [Upgrade].

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

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

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

Adds a timeout to the connection setup (including upgrades) for all inbound and outbound connection attempts.

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

Adds a timeout to the connection setup (including upgrades) for all outbound connection attempts.

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

Adds a timeout to the connection setup (including upgrades) for all inbound connection attempts.