Struct P2pPathCell 

pub struct P2pPathCell(/* private fields */);

Shared, live view of a virtual connection’s P2pPath, read by the application’s channel and written when a P2P connection is established, lost, or given up on. Every change is published, so an application can subscribe instead of polling.

Implementations

impl P2pPathCell

pub fn get(&self) -> P2pPath

pub fn relayed_both(&self) -> bool

True when the path is P2pPath::Turn through two allocations (both peers relayed), for accounting double TURN egress.

pub fn status(&self) -> P2pPathStatus

The current path and campaign state.

pub fn subscribe(&self) -> Receiver<P2pPathStatus>

A receiver that wakes on every path or campaign change.

pub fn last_outcome(&self) -> Option<PathAttemptOutcome>

The outcome of the latest upgrade attempt: which path it attached and why each stage that did not connect failed. None until the first attempt ends.

pub fn outcomes(&self) -> Receiver<Option<PathAttemptOutcome>>

A receiver that wakes as each upgrade attempt ends, holding the latest outcome. Every outcome is also delivered to the kernel as NodeResult::PeerPathOutcome, which a slow reader of this receiver cannot miss.

pub fn bytes(&self) -> PathBytesSnapshot

The bytes this connection has sent and received on each path so far, across every route it has had. Monotonic.

pub fn class_gates(&self) -> ClassGates

Which classes of traffic each path of this connection may carry.

pub fn permits(&self, class: PathClass) -> bool

Whether the path traffic takes right now may carry class.

pub fn check(&self, class: PathClass) -> Result<(), NetworkError>

Ok when the current path may carry class, else the typed refusal.

pub fn ensure_direct( &self, ) -> impl Future<Output = Result<P2pPath, NetworkError>> + Send + 'static

Resolves Ok with the path once traffic runs over a P2P connection (hole-punched P2pPath::Direct, or P2pPath::Turn when a TURN config was supplied), and Err once the background campaign has ended without one: every attempt failed, the NATs are incompatible and no TURN config was supplied, or the connection closed. It has no timeout of its own; it follows the campaign. After a P2P path is lost the connection falls back to the server relay and a bounded retry is scheduled, so a new call waits for that retry.

Trait Implementations

impl Clone for P2pPathCell

fn clone(&self) -> P2pPathCell

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for P2pPathCell

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

Formats the value using the given formatter.