Struct libp2p_relay::RelayTransport

pub struct RelayTransport<T: Clone> { /* fields omitted */ }

A Transport wrapping another Transport enabling relay capabilities.

Allows the local node to:

1. Use inner wrapped transport as before.

   relay_transport.dial(Multiaddr::empty().with(Protocol::Memory(42)));

2. Establish relayed connections by dialing /p2p-circuit addresses.

   let dst_addr_via_relay = Multiaddr::empty()
       .with(Protocol::Memory(40)) // Relay address.
       .with(Protocol::P2p(PeerId::random().into())) // Relay peer id.
       .with(Protocol::P2pCircuit) // Signal to connect via relay and not directly.
       .with(Protocol::Memory(42)) // Destination address.
       .with(Protocol::P2p(PeerId::random().into())); // Destination peer id.
   relay_transport.dial(dst_addr_via_relay).unwrap();

3. Listen for incoming relayed connections via specific relay.

   let relay_addr = Multiaddr::empty()
       .with(Protocol::Memory(40)) // Relay address.
       .with(Protocol::P2p(PeerId::random().into())) // Relay peer id.
       .with(Protocol::P2pCircuit); // Signal to listen via remote relay node.
   relay_transport.listen_on(relay_addr).unwrap();

4. Listen for incoming relayed connections via any relay.

   Note: Without this listener, incoming relayed connections from relays, that the local node is not explicitly listening via, are dropped.

   let addr = Multiaddr::empty()
       .with(Protocol::P2pCircuit); // Signal to listen via any relay.
   relay_transport.listen_on(addr).unwrap();

Trait Implementations

impl<T: Clone> Clone for RelayTransport<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Transport + Clone> Transport for RelayTransport<T>

type Output = EitherOutput<<T as Transport>::Output, Connection>

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

type Error = EitherError<<T as Transport>::Error, RelayError>

An error that occurred during connection setup.

type Listener = RelayListener<T>

A stream of Outputs for inbound connections.

type ListenerUpgrade = RelayedListenerUpgrade<T>

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

type Dial = EitherFuture<<T as Transport>::Dial, BoxFuture<'static, Result<Connection, RelayError>>>

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

pub fn boxed(self) -> Boxed<Self::Output> where
    Self: Transport + Clone + Send + Sync + 'static,
    Self::Dial: Send,
    Self::Dial: 'static,
    Self::Listener: Send,
    Self::Listener: 'static,
    Self::ListenerUpgrade: Send,
    Self::ListenerUpgrade: 'static,
    Self::Error: Send,
    Self::Error: Sync, 

Boxes the transport, including custom transport errors.

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

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

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

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

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

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