Struct libp2p::uds::UdsConfig

pub struct UdsConfig {}

Represents the configuration for a Unix domain sockets transport capability for libp2p.

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

Methods

impl UdsConfig

pub fn new() -> UdsConfig

Creates a new configuration object for TCP/IP.

Trait Implementations

impl Transport for UdsConfig

type Output = UnixStream

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

type Error = Error

An error that occurred during connection setup.

type Listener = ListenerStream<Incoming>

A stream of Outputs for inbound connections.

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

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

type Dial = ConnectFuture

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

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

Listens on the given [Multiaddr], producing a stream of pending, inbound connections.

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

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

fn nat_traversal(
    &self,
    server: &Multiaddr,
    observed: &Multiaddr
) -> Option<Multiaddr>

Takes a [Multiaddr] that represents a listening address together with an an address observed by another node and tries to incoporate information from the observed address into the listening address, yielding an externally-visible address.

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.

impl Clone for UdsConfig

fn clone(&self) -> UdsConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UdsConfig

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

Formats the value using the given formatter.