Enum FrameType 

#[repr(u32)]
pub enum FrameType {
    ServerChallenge = 0,
    ClientAuth = 1,
    ServerConfirmsAuth = 2,
    ServerDeniesAuth = 3,
    ClientToRelayDatagram = 4,
    ClientToRelayDatagramBatch = 5,
    RelayToClientDatagram = 6,
    RelayToClientDatagramBatch = 7,
    EndpointGone = 8,
    Ping = 9,
    Pong = 10,
    Health = 11,
    Restarting = 12,
}

Possible frame types during handshaking

Variants

ServerChallenge = 0

The server frame type for the challenge response

ClientAuth = 1

The client frame type for the authentication frame

ServerConfirmsAuth = 2

The server frame type for authentication confirmation

ServerDeniesAuth = 3

The server frame type for authentication denial

ClientToRelayDatagram = 4

32B dest pub key + ECN bytes + one datagram’s content

ClientToRelayDatagramBatch = 5

32B dest pub key + ECN byte + segment size u16 + datagrams contents

RelayToClientDatagram = 6

32B src pub key + ECN bytes + one datagram’s content

RelayToClientDatagramBatch = 7

32B src pub key + ECN byte + segment size u16 + datagrams contents

EndpointGone = 8

Sent from server to client to signal that a previous sender is no longer connected.

That is, if A sent to B, and then if A disconnects, the server sends FrameType::PeerGone to B so B can forget that a reverse path exists on that connection to get back to A

32B pub key of peer that’s gone

Ping = 9

Messages with these frames will be ignored. 8 byte ping payload, to be echoed back in FrameType::Pong

Pong = 10

8 byte payload, the contents of ping being replied to

Health = 11

Sent from server to client to tell the client if their connection is unhealthy somehow. Contains only UTF-8 bytes.

Restarting = 12

Sent from server to client for the server to declare that it’s restarting. Payload is two big endian u32 durations in milliseconds: when to reconnect, and how long to try total.

Trait Implementations

impl Clone for FrameType

fn clone(&self) -> FrameType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameType

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

Formats the value using the given formatter.

impl From<FrameType> for VarInt

fn from(value: FrameType) -> Self

Converts to this type from the input type.

impl From<FrameType> for u32

fn from(enum_value: FrameType) -> Self

Converts to this type from the input type.

impl PartialEq for FrameType

fn eq(&self, other: &FrameType) -> 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 TryFrom<u32> for FrameType

type Error = TryFromPrimitiveError<FrameType>

The type returned in the event of a conversion error.

fn try_from(number: u32) -> Result<Self, TryFromPrimitiveError<Self>>

Performs the conversion.

impl TryFromPrimitive for FrameType

const NAME: &'static str = "FrameType"

type Primitive = u32

type Error = TryFromPrimitiveError<FrameType>

fn try_from_primitive( number: Self::Primitive, ) -> Result<Self, TryFromPrimitiveError<Self>>

impl Copy for FrameType

impl Eq for FrameType

impl StructuralPartialEq for FrameType