Enum Message 

#[non_exhaustive]
pub enum Message {
    Ping,
    Pong,
    JoinRelayRequest {
        token: String,
    },
    JoinSessionRequest {
        key: Vec<u8>,
    },
    Response {
        code: i32,
        message: String,
    },
    ConnectRequest {
        id: Vec<u8>,
    },
    SessionInvitation {
        from: Vec<u8>,
        key: Vec<u8>,
        address: Vec<u8>,
        port: u16,
        server_socket: bool,
    },
    RelayFull,
}

One bep-relay control message.

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.

Ping

Periodic keepalive sent by either side.

Pong

Keepalive acknowledgement.

JoinRelayRequest

Join the relay registration with an optional access token.

Fields

token: String

JoinSessionRequest

Propose to join an existing session with its shared key.

Fields

key: Vec<u8>

Response

Status reply to a previous request.

Fields

code: i32

message: String

ConnectRequest

Ask the relay to broker a session towards a device id.

Fields

id: Vec<u8>

SessionInvitation

An invitation to a session, delivered to the dialed device on its registered connection and to the dialing device on the fresh connection that carried the connection request.

Fields

from: Vec<u8>

key: Vec<u8>

address: Vec<u8>

port: u16

server_socket: bool

RelayFull

The relay has no capacity left.

Implementations

impl Message

pub const RESPONSE_SUCCESS: i32 = 0

Response code for a successful request.

pub const RESPONSE_NOT_FOUND: i32 = 1

Response code: the dialed device is unknown to the relay.

pub const RESPONSE_ALREADY_CONNECTED: i32 = 2

Response code: the device is already connected to the relay.

pub const RESPONSE_WRONG_TOKEN: i32 = 3

Response code: the join token was rejected.

pub const RESPONSE_UNEXPECTED: i32 = 100

Response code: an unexpected message arrived.

pub fn encode_frame(&self) -> Result<Vec<u8>>

Encode self into a complete wire frame (header + payload).

Errors

Returns an error if the payload exceeds MAX_MESSAGE_LENGTH.

pub fn decode_frame(frame: &[u8]) -> Result<Self>

Decode a complete wire frame (header + payload) into a message.

Errors

Returns an error if the frame is malformed, truncated, or carries an unknown message type.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl Eq for Message

impl PartialEq for Message

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Message