Struct libp2p_tcp::TcpConfig

pub struct TcpConfig { /* private fields */ }

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 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 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 Default for TcpConfig

fn default() -> TcpConfig

Returns the “default value” for a type.

impl Transport for TcpConfig

type Output = TcpTransStream

The raw connection to a peer.

type Error = Error

Error that can happen when dialing or listening.

type Listener = TcpListenStream

The listener produces incoming connections.

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

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

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 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 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.