Struct libp2p_dns::DnsConfig

pub struct DnsConfig<T> { /* private fields */ }

Represents the configuration for a DNS transport capability of libp2p.

This struct implements the Transport trait and holds an underlying transport. Any call to dial with a multiaddr that contains /dns4/ or /dns6/ will be first be resolved, then passed to the underlying transport.

Listening is unaffected.

Implementations

impl<T> DnsConfig<T>

pub fn new(inner: T) -> DnsConfig<T>

Creates a new configuration object for DNS.

pub fn with_resolve_threads(inner: T, num_threads: usize) -> DnsConfig<T>

Same as new, but allows specifying a number of threads for the resolving.

Trait Implementations

impl<T: Clone> Clone for DnsConfig<T>

fn clone(&self) -> DnsConfig<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for DnsConfig<T>where
    T: Debug,

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

Formats the value using the given formatter.

impl<T> Transport for DnsConfig<T>where
    T: Transport,

type Output = <T as Transport>::Output

The raw connection to a peer.

type Listener = <T as Transport>::Listener

The listener produces incoming connections.

type ListenerUpgrade = <T as Transport>::ListenerUpgrade

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 = Either<<T as Transport>::Dial, DialFuture<T, JoinFuture<JoinAll<IntoIter<Either<ResolveFuture<Box<dyn Future<Item = Vec<IpAddr, Global>, Error = Error> + Send + 'static, Global>>, FutureResult<Protocol<'static>, Error>>, Global>>>>>

A future which indicates that we are currently dialing to a peer.

fn listen_on(
    self,
    addr: Multiaddr
) -> Result<(Self::Listener, Multiaddr), (Self, Multiaddr)>

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, (Self, Multiaddr)>

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>(self, map_err: F) -> MapErr<Self, F>where
    Self: Sized,
    F: FnOnce(Error) -> Error + Clone,

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

fn map_err_dial<F>(self, map_err: F) -> MapErrDial<Self, F>where
    Self: Sized,
    F: FnOnce(Error, Multiaddr) -> Error,

Applies a function on the errors generated by the futures of the Transport when dialing.

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, Error = Error>,

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.