Struct RelayStatus 

pub struct RelayStatus { /* private fields */ }

Live relay-connection status, shared (via Arc) between the connection task and an RPC handler. Cheap atomic reads. State setters do STATE-CHANGE-ONLY logging so a long outage never hot-loops identical error lines.

Implementations

impl RelayStatus

pub fn new() -> Arc<Self>

A fresh status (resting Disconnected until the task runs / the relay is reached).

pub fn state(&self) -> RelayState

Read the current state.

pub fn set_disabled(&self)

Enter Disabled (reservation off). Idempotent; logs only on the first entry.

pub fn set_connecting(&self)

Enter Connecting. Logs only on the transition (so reconnect attempts don’t spam).

pub fn set_connected(&self, connected_peers: u64)

Mark Connected (clears the last error, resets the attempt counter). Logs recovery once.

pub fn set_disconnected(&self, error: Option<String>)

Mark Disconnected with an optional error and bump the attempt counter. Logs the failure ONLY on the transition into Disconnected (the first drop); subsequent failed retries while already Disconnected update the error/counter SILENTLY.

pub fn is_connected(&self) -> bool

Whether a relay session is currently held.

pub fn reconnect_attempts(&self) -> u32

The current reconnect-attempt count (for tests / RPC).

pub fn known_peers(&self) -> Vec<RelayPeerInfo>

Snapshot of the peers discovered over the live reservation socket (RLY-005 Peers + PeerConnected pushes, minus PeerDisconnected). The consumer folds these into its address book / pool. Returns a clone so the caller holds no lock.

pub fn known_peer_count(&self) -> usize

Count of peers currently discovered over the live reservation socket.

pub fn relay_transport_ready(&self) -> bool

Whether a relayed tunnel can currently be opened — a reservation is held AND its outbound sink is live. The tier-6 RelayedTransport gates on this.

pub fn open_tunnel( self: &Arc<Self>, target_peer: &str, network_id: &str, ) -> Result<RelayTunnel, String>

Open an RLY-002 relayed-transport tunnel to target_peer (hex peer_id) over the held reservation socket — the traversal ladder’s FINAL tier when a pair can neither direct-dial nor hole-punch. The returned RelayTunnel sends/receives opaque payloads that the relay forwards A→relay→B; per NC-1 the payload is END-TO-END SEALED to the recipient so the relay forwards ciphertext only. Err if no reservation is held. Dropping the tunnel deregisters it.

pub fn snapshot_json(&self, endpoint: &str, peer_id: &str) -> Value

A JSON snapshot for a control.relayStatus-style RPC. state is the canonical truth; connected is a convenience boolean (== state == connected).

Trait Implementations

impl Debug for RelayStatus

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

Formats the value using the given formatter.

impl Default for RelayStatus

fn default() -> Self

Returns the “default value” for a type.