Struct libp2p_tokio_socks5::Socks5TokioTcpConfig

pub struct Socks5TokioTcpConfig { /* 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.

Implementations

impl Socks5TokioTcpConfig

pub fn new(socks_port: u16) -> Self

Creates a new configuration object for TCP/IP.

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

Sets the TTL to set for opened sockets.

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

Sets the TCP_NODELAY to set for opened sockets.

pub fn onion_map(self, value: HashMap<Multiaddr, u16>) -> Self

Sets the map for onion address -> local socket port number.

pub fn socks_port(self, port: u16) -> Self

Sets the Tor SOCKS5 proxy port number.

Trait Implementations

impl Clone for Socks5TokioTcpConfig

fn clone(&self) -> Socks5TokioTcpConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Socks5TokioTcpConfig

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

Formats the value using the given formatter.

impl Default for Socks5TokioTcpConfig

fn default() -> Self

Creates a new configuration object for TCP/IP using the default Tor SOCKS5 port - 9050.

impl Transport for Socks5TokioTcpConfig

type Output = TokioTcpTransStream

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

type Error = Error

An error that occurred during connection setup.

type Listener = Pin<Box<dyn Stream<Item = Result<ListenerEvent<Self::ListenerUpgrade, Self::Error>, Self::Error>> + Send>>

A stream of Outputs for inbound connections.

type ListenerUpgrade = Ready<Result<Self::Output, Self::Error>>

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

type Dial = Pin<Box<dyn Future<Output = Result<TokioTcpTransStream, Error>> + Send>>

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 the transport into an abstract boxed (i.e. heap-allocated) transport.

fn map<F, O>(self, f: 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, E>(self, f: F) -> MapErr<Self, F> where
    F: FnOnce(Self::Error) -> E + Clone, 

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

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

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

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

Adds a timeout to the connection setup (including upgrades) for all inbound and outbound connections established through the transport.

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

Adds a timeout to the connection setup (including upgrades) for all outbound connections established through the transport.

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

Adds a timeout to the connection setup (including upgrades) for all inbound connections established through the transport.

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

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