Struct libp2p_uds::UdsConfig

pub struct UdsConfig { /* private fields */ }

Available on Unix and non-Emscripten and (crate features tokio or async-std) only.

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

Implementations

impl UdsConfig

pub fn new() -> UdsConfig

Creates a new configuration object for Unix domain sockets.

Trait Implementations

impl Default for UdsConfig

fn default() -> Self

Returns the “default value” for a type.

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 ListenerUpgrade = Ready<Result<<UdsConfig as Transport>::Output, <UdsConfig as Transport>::Error>>

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

type Dial = Pin<Box<dyn Future<Output = Result<<UdsConfig as Transport>::Output, <UdsConfig as Transport>::Error>> + Send + 'static, Global>>

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

fn listen_on(
    &mut self,
    addr: Multiaddr
) -> Result<ListenerId, TransportError<Self::Error>>

Listens on the given [Multiaddr] for inbound connections.

fn remove_listener(&mut self, id: ListenerId) -> bool

Remove a listener.

fn dial(
    &mut self,
    addr: Multiaddr
) -> Result<Self::Dial, TransportError<Self::Error>>

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

fn dial_as_listener(
    &mut self,
    addr: Multiaddr
) -> Result<Self::Dial, TransportError<Self::Error>>

As Transport::dial but has the local node act as a listener on the outgoing connection.

fn address_translation(
    &self,
    _server: &Multiaddr,
    _observed: &Multiaddr
) -> Option<Multiaddr>

Performs a transport-specific mapping of an address observed by a remote onto a local listen address to yield an address for the local node that may be reachable for other peers.

fn poll(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<TransportEvent<Self::ListenerUpgrade, Self::Error>>

Poll for TransportEvents.

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

Applies a function on the connections created by the transport.

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

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

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

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

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

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