Enum DeviceMessage 

pub enum DeviceMessage {
    Enroll {
        enroll_token: String,
        version: u32,
        label: Option<String>,
    },
    Attach {
        device_id: String,
        enroll_token: String,
    },
    Heartbeat,
}

Device → relay.

Variants

Enroll

First message: ask to attach to this relay.

Fields

enroll_token: String

Shared secret proving the device may attach.

version: u32

Protocol version the device speaks.

label: Option<String>

Free-form label to make the device recognisable in relay logs.

Attach

First frame on a data connection: claim a slot in a device’s pool.

The secret travels in the frame body, never in the URL. Query strings are written to access logs by default by the reverse proxies this relay is meant to sit behind, so a token in the URL would end up on disk in plaintext on every deployment that follows our own TLS advice.

Fields

device_id: String

Which device’s pool this connection joins.

enroll_token: String

Same secret the control channel presented.

Heartbeat

Liveness heartbeat.

Sent by the device rather than relied upon from the transport: a proxy or load balancer between the two closes idle connections (60s is the common default), and tungstenite answers pings but never originates them.

Trait Implementations

impl Clone for DeviceMessage

fn clone(&self) -> DeviceMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DeviceMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for DeviceMessage

impl PartialEq for DeviceMessage

fn eq(&self, other: &DeviceMessage) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for DeviceMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DeviceMessage