Enum ControlMessage 

pub enum ControlMessage {
    Hello {
        version: u8,
        requested_id: Option<String>,
        auth_token: Option<String>,
    },
    Welcome {
        tunnel_id: String,
        tunnel_url: String,
    },
    ClientConnected {
        client_id: String,
    },
    ClientDisconnected {
        client_id: String,
    },
    Ping {
        timestamp: u64,
    },
    Pong {
        timestamp: u64,
    },
    Close {
        reason: String,
    },
    Error {
        code: String,
        message: String,
    },
}

Control messages for tunnel management (sent in plaintext over WSS)

Variants

Hello

Agent -> Relay: Initial handshake to establish tunnel

Fields

version: u8

Protocol version

requested_id: Option<String>

Requested tunnel ID (optional, relay may assign random)

auth_token: Option<String>

Authentication token (optional, required if relay enforces auth)

Welcome

Relay -> Agent: Handshake response with assigned tunnel info

Fields

tunnel_id: String

Assigned tunnel ID

tunnel_url: String

Base URL for the tunnel (without fragment) e.g., “https://abc12345.relay.example.com”

ClientConnected

Relay -> Agent: A client has connected to the tunnel

Fields

client_id: String

Unique identifier for this client connection

ClientDisconnected

Relay -> Agent: A client has disconnected

Fields

client_id: String

Client identifier

Ping

Bidirectional: Keep-alive ping

Fields

timestamp: u64

Timestamp for latency measurement (milliseconds)

Pong

Bidirectional: Keep-alive pong

Fields

timestamp: u64

Echo of the ping timestamp

Close

Either side: Graceful close

Fields

reason: String

Human-readable reason for closing

Error

Relay -> Agent/Client: Error occurred

Fields

code: String

Error code

message: String

Human-readable error message

Trait Implementations

impl Clone for ControlMessage

fn clone(&self) -> ControlMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ControlMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ControlMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ControlMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.