Enum RelayMessage 

#[non_exhaustive]
pub enum RelayMessage {
    Register {
        peer_id: String,
        network_id: String,
        protocol_version: u32,
        listen_addrs: Vec<SocketAddr>,
    },
    RegisterAck {
        success: bool,
        message: String,
        connected_peers: usize,
    },
    Unregister {
        peer_id: String,
    },
    RelayGossipMessage {
        from: String,
        to: String,
        payload: Vec<u8>,
        seq: u64,
    },
    Broadcast {
        from: String,
        payload: Vec<u8>,
        exclude: Vec<String>,
    },
    PeerConnected {
        peer: RelayPeerInfo,
    },
    PeerDisconnected {
        peer_id: String,
    },
    GetPeers {
        network_id: Option<String>,
    },
    Peers {
        peers: Vec<RelayPeerInfo>,
    },
    Ping {
        timestamp: u64,
    },
    Pong {
        timestamp: u64,
    },
    HolePunchRequest {
        peer_id: String,
        target_peer_id: String,
        external_addr: SocketAddr,
    },
    HolePunchCoordinate {
        peer_id: String,
        external_addr: SocketAddr,
    },
    HolePunchResult {
        peer_id: String,
        success: bool,
    },
    GetDhtRecords {
        max_keys: usize,
    },
    DhtRecords {
        records: Vec<DhtRecordEntry>,
        total_keys: usize,
        truncated: bool,
    },
    Error {
        code: u32,
        message: String,
    },
}

Complete relay protocol message enum — JSON over WebSocket, #[serde(tag = "type")].

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Register

Client → Relay: register after WebSocket connect.

Fields

peer_id: String

network_id: String

protocol_version: u32

listen_addrs: Vec<SocketAddr>

RegisterAck

Relay → Client: registration acknowledgement.

Fields

success: bool

message: String

connected_peers: usize

Unregister

Client → Relay: graceful disconnect.

Fields

peer_id: String

RelayGossipMessage

Client → Relay → Client: forward to a specific peer.

Fields

from: String

to: String

payload: Vec<u8>

seq: u64

Broadcast

Client → Relay → All: broadcast to all relay peers.

Fields

from: String

payload: Vec<u8>

exclude: Vec<String>

PeerConnected

Relay → Client: new peer connected to relay.

Fields

peer: RelayPeerInfo

PeerDisconnected

Relay → Client: peer disconnected from relay.

Fields

peer_id: String

GetPeers

Client → Relay: request connected peer list.

Fields

network_id: Option<String>

Peers

Relay → Client: peer list response.

Fields

peers: Vec<RelayPeerInfo>

Ping

Bidirectional keepalive.

Fields

timestamp: u64

Pong

Keepalive response.

Fields

timestamp: u64

HolePunchRequest

Client → Relay: request hole-punch coordination.

Fields

peer_id: String

target_peer_id: String

external_addr: SocketAddr

HolePunchCoordinate

Relay → Client: hole-punch coordination (the other peer’s external address).

Fields

peer_id: String

external_addr: SocketAddr

HolePunchResult

Client → Relay: hole-punch result.

Fields

peer_id: String

success: bool

GetDhtRecords

Relay → Client: ask this node for an AGGREGATED view of its DHT provider records.

The relay is not a DHT node and holds no records, but it already keeps a live reservation to every registered peer — and a Kademlia node stores records for keys near its OWN peer_id, so its store describes MANY OTHER peers’ content. Asking each connected node therefore yields a broad slice of the real DHT without the relay ever joining it.

max_keys bounds the answer. Additive (NC-6 soft-fork): a pre-RLY-009 node does not recognise this type and simply never answers, which the relay MUST treat as “no data” rather than an error.

Fields

max_keys: usize

DhtRecords

Client → Relay: the aggregated view requested by RelayMessage::GetDhtRecords.

Carries COUNTS, never provider identities — a provider record is a (peer_id, content_key) pair, and publishing that linkage is exactly what the relay’s /map privacy contract forbids.

Fields

records: Vec<DhtRecordEntry>

total_keys: usize

Keys with a live provider BEFORE max_keys was applied, so the relay can report “showing N of M” instead of presenting a truncated view as complete.

truncated: bool

Error

Relay → Client: error notification.

Fields

code: u32

message: String

Trait Implementations

impl Clone for RelayMessage

fn clone(&self) -> RelayMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RelayMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RelayMessage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RelayMessage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.