Struct xstack_circuit::CircuitTransport

pub struct CircuitTransport { /* private fields */ }

The implementation of transport circuit_v2.

The below codes show how to enable this.

use xstack::Switch;
use xstack_circuit::CircuitTransport;

Switch::new("test")
      .transport(CircuitTransport::default())
      // if the node want to enable sub-protocol '/libp2p/circuit/relay/0.2.0/stop'
      .transport_bind(["/p2p-circuit"])
      .create()
      .await
      .unwrap()
      // register to global context.
      .into_global();

Note: the multiaddr ‘/p2p-circuit’ can’t be bound twice for same Switch.

Trait Implementations

impl Default for CircuitTransport

fn default() -> CircuitTransport

Returns the “default value” for a type.

impl DriverTransport for CircuitTransport

fn bind<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, switch: &'life1 Switch, laddr: &'life2 Multiaddr, ) -> Pin<Box<dyn Future<Output = Result<TransportListener>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Create a server-side socket with provided laddr.

fn connect<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, switch: &'life1 Switch, raddr: &'life2 Multiaddr, ) -> Pin<Box<dyn Future<Output = Result<P2pConn>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Connect to peer with remote peer raddr.

fn multiaddr_hint(&self, addr: &Multiaddr) -> bool

Check if this transport support the protocol stack represented by the addr.

fn name(&self) -> &str

Returns the transport’s display name.

fn activities(&self) -> usize

Returns the actives connection number.