Enum ControlFrame 

pub enum ControlFrame {
    IpRequest {
        requester_id: NodeId,
    },
    IpAssign {
        assigned_ip: [u8; 4],
        subnet_mask: u8,
        gateway_ip: [u8; 4],
        lease_seconds: u32,
    },
    Goodbye {
        departing_id: NodeId,
        reason: u8,
    },
    Rekey,
    Ping {
        nonce: u64,
    },
    Pong {
        nonce: u64,
    },
    PeerInfo {
        x25519_pub: [u8; 32],
        friendly_name: String,
    },
    Message {
        message_id: [u8; 16],
        timestamp_ms: u64,
        ciphertext: Vec<u8>,
    },
    MessageAck {
        message_id: [u8; 16],
        ack_kind: u8,
    },
}

Multiplexed control message.

Layout: control_type(1) + body (variable, depends on type)

Variants

IpRequest

Request an address lease from a gateway.

Fields

requester_id: NodeId

Node requesting a mesh IP allocation.

IpAssign

Lease configuration returned by a gateway.

Fields

assigned_ip: [u8; 4]

Assigned mesh IPv4 address.

subnet_mask: u8

CIDR prefix length for the assigned subnet.

gateway_ip: [u8; 4]

Mesh IPv4 address of the serving gateway.

lease_seconds: u32

Lease duration in seconds.

Goodbye

Graceful disconnect notification.

Fields

departing_id: NodeId

Node that is departing.

reason: u8

Implementation-defined reason code.

Rekey

Request that the session be rekeyed.

Ping

Ping carrying an opaque nonce.

Fields

nonce: u64

Opaque value echoed by the corresponding pong.

Pong

Pong echoing a ping nonce.

Fields

nonce: u64

Opaque value copied from the ping request.

PeerInfo

Identity metadata exchanged once after the session is established so that peers can address each other by NodeId and end-to-end encrypt to the recipient’s static X25519 key.

Fields

x25519_pub: [u8; 32]

X25519 public key derived from the sender’s Ed25519 seed.

friendly_name: String

Sender’s friendly node name as configured locally (UTF-8, length-prefixed by u8 — capped at 255 bytes by the codec).

Message

End-to-end encrypted user message.

Carried inside a MeshDataFrame with both DataFlags::IS_CONTROL and DataFlags::IS_E2E set. ciphertext is the literal output of pim_crypto::e2e_encrypt.

Fields

message_id: [u8; 16]

16-byte stable identifier (UUIDv4 bytes).

timestamp_ms: u64

Sender-stamped wall-clock time in milliseconds since epoch.

ciphertext: Vec<u8>

ECIES-encrypted UTF-8 plaintext.

MessageAck

Receipt for a previously sent ControlFrame::Message.

Fields

message_id: [u8; 16]

Identifier of the original message being acknowledged.

ack_kind: u8

Acknowledgement category: 1 = delivered, 2 = read.

Trait Implementations

impl Clone for ControlFrame

fn clone(&self) -> ControlFrame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ControlFrame

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

Formats the value using the given formatter.

impl FrameCodec for ControlFrame

fn encode(&self, buf: &mut BytesMut)

Encode self into the provided mutable buffer.

fn decode(buf: &mut BytesMut) -> Result<Self, PimError>

Decode one frame from the provided buffer.

impl PartialEq for ControlFrame

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ControlFrame

impl StructuralPartialEq for ControlFrame