Enum ProtocolCommand 

pub enum ProtocolCommand {
    SendReliable {
        channel_id: u8,
        sequence: u16,
        ordered: bool,
        data: SharedBytes,
    },
    SendUnreliable {
        channel_id: u8,
        data: SharedBytes,
    },
    SendUnreliableSequenced {
        channel_id: u8,
        sequence: u16,
        data: SharedBytes,
    },
    SendUnsequenced {
        channel_id: u8,
        unsequenced_group: u16,
        data: SharedBytes,
    },
    SendFragment {
        channel_id: u8,
        sequence: u16,
        ordered: bool,
        fragment_id: u8,
        fragment_count: u8,
        data: SharedBytes,
    },
    SendUnreliableFragment {
        channel_id: u8,
        sequence: u16,
        fragment_id: u8,
        fragment_count: u8,
        data: SharedBytes,
    },
    Acknowledge {
        sequence: u16,
        received_mask: u32,
        sent_time: Option<u32>,
    },
    Ping {
        timestamp: u32,
    },
    Pong {
        timestamp: u32,
    },
    Connect {
        channels: u8,
        mtu: u16,
        protocol_version: u16,
        outgoing_session_id: u16,
        connect_id: u32,
    },
    VerifyConnect {
        peer_id: u16,
        channels: u8,
        mtu: u16,
        incoming_session_id: u16,
        outgoing_session_id: u16,
        window_size: u32,
    },
    Disconnect {
        reason: u32,
    },
    BandwidthLimit {
        incoming: u32,
        outgoing: u32,
    },
    ThrottleConfigure {
        interval: u32,
        acceleration: u32,
        deceleration: u32,
    },
    PMTUProbe {
        size: u16,
        token: u32,
        payload: SharedBytes,
    },
    PMTUReply {
        size: u16,
        token: u32,
    },
}

Protocol commands that can be sent between peers.

All protocol operations are represented as discrete commands that can be aggregated.

Variants

SendReliable

Send reliable data on a channel

Fields

channel_id: u8

Channel identifier (0-255)

sequence: u16

Sequence number for ordering

ordered: bool

Whether to deliver in order on receive (true) or unordered (false)

data: SharedBytes

Payload data (shared, sliceable)

SendUnreliable

Send unreliable data on a channel

Fields

channel_id: u8

Channel identifier (0-255)

data: SharedBytes

Payload data (shared slice)

SendUnreliableSequenced

Send sequenced unreliable data (drops old packets)

Fields

channel_id: u8

Channel identifier (0-255)

sequence: u16

Sequence number for dropping old packets

data: SharedBytes

Payload data (shared slice)

SendUnsequenced

Send unsequenced unreliable data (prevents duplicates without ordering)

Fields

channel_id: u8

Channel identifier (0-255)

unsequenced_group: u16

Unsequenced group identifier for duplicate detection

data: SharedBytes

Payload data (shared slice)

SendFragment

Fragment of a larger reliable packet

Fields

channel_id: u8

Channel identifier (0-255)

sequence: u16

Sequence number of the original packet

ordered: bool

Whether to deliver in order on receive (true) or unordered (false)

fragment_id: u8

Fragment index (0-based)

fragment_count: u8

Total number of fragments

data: SharedBytes

Fragment data (shared slice)

SendUnreliableFragment

Fragment of a larger unreliable packet

Fields

channel_id: u8

Channel identifier (0-255)

sequence: u16

Sequence number of the original packet (for reassembly)

fragment_id: u8

Fragment index (0-based)

fragment_count: u8

Total number of fragments

data: SharedBytes

Fragment data (shared slice)

Acknowledge

Acknowledge received reliable packets

Fields

sequence: u16

Sequence number being acknowledged

received_mask: u32

Bitfield of additional acknowledged packets (32 packets before sequence)

sent_time: Option<u32>

Timestamp for RTT calculation (optional)

Ping

Ping to measure RTT and keep connection alive

Fields

timestamp: u32

Timestamp (milliseconds since epoch or relative)

Pong

Pong response to ping

Fields

timestamp: u32

Original timestamp from ping

Connect

Request to establish connection (3-way handshake step 1)

Fields

channels: u8

Number of channels to allocate

mtu: u16

Maximum transmission unit

protocol_version: u16

Protocol version

outgoing_session_id: u16

Outgoing session ID from client

connect_id: u32

Connect ID for replay protection

VerifyConnect

Verify connection (3-way handshake step 2) - replaces old ConnectAck

Fields

peer_id: u16

Assigned peer ID

channels: u8

Channels allocated

mtu: u16

Maximum transmission unit

incoming_session_id: u16

Incoming session ID (from server’s perspective)

outgoing_session_id: u16

Outgoing session ID (from server’s perspective)

window_size: u32

Window size for flow control

Disconnect

Request to disconnect

Fields

reason: u32

Reason code (application-defined)

BandwidthLimit

Bandwidth limit notification

Fields

incoming: u32

Incoming bandwidth limit (bytes/sec, 0 = unlimited)

outgoing: u32

Outgoing bandwidth limit (bytes/sec, 0 = unlimited)

ThrottleConfigure

Throttle configuration for congestion control

Fields

interval: u32

Throttle interval in milliseconds

acceleration: u32

Throttle acceleration rate

deceleration: u32

Throttle deceleration rate

PMTUProbe

Path MTU probe: request to test a payload of given size

Fields

size: u16

Probe payload size in bytes

token: u32

Correlation token

payload: SharedBytes

Probe payload (shared slice) sized to size

PMTUReply

Path MTU reply: response to a PMTU probe

Fields

size: u16

Echoed probe size

token: u32

Echoed token

Implementations

impl ProtocolCommand

pub fn command_type(&self) -> u8

Returns the command type identifier for serialization

pub fn is_reliable(&self) -> bool

Returns true if this command requires reliable delivery

pub fn channel_id(&self) -> Option<u8>

Returns the channel ID if this is a data command

Trait Implementations

impl Clone for ProtocolCommand

fn clone(&self) -> ProtocolCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtocolCommand

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

Formats the value using the given formatter.

impl PartialEq for ProtocolCommand

fn eq(&self, other: &ProtocolCommand) -> 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 StructuralPartialEq for ProtocolCommand