Enum ControlPayload 

#[repr(u8)]
pub enum ControlPayload {
    OpenChannel {
        channel_id: u32,
        service_name: String,
        method_name: String,
        metadata: Vec<(String, Vec<u8>)>,
    },
    CloseChannel {
        channel_id: u32,
        reason: CloseReason,
    },
    CancelChannel {
        channel_id: u32,
        reason: CancelReason,
    },
    GrantCredits {
        channel_id: u32,
        bytes: u32,
    },
    Ping {
        payload: [u8; 8],
    },
    Pong {
        payload: [u8; 8],
    },
}

Control channel payloads (channel 0).

The method_id in MsgDescHot indicates the verb:

• 1: OpenChannel
• 2: CloseChannel
• 3: CancelChannel
• 4: GrantCredits
• 5: Ping
• 6: Pong

Variants

OpenChannel

Open a new data channel.

Fields

channel_id: u32

service_name: String

method_name: String

metadata: Vec<(String, Vec<u8>)>

CloseChannel

Close a channel gracefully.

Fields

channel_id: u32

reason: CloseReason

CancelChannel

Cancel a channel.

Fields

channel_id: u32

reason: CancelReason

GrantCredits

Grant flow control credits.

Fields

channel_id: u32

bytes: u32

Ping

Liveness probe.

Fields

payload: [u8; 8]

Pong

Response to Ping.

Fields

payload: [u8; 8]

Trait Implementations

impl Clone for ControlPayload

fn clone(&self) -> ControlPayload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ControlPayload

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

Formats the value using the given formatter.

impl<'ʄ> Facet<'ʄ> for ControlPayload

const SHAPE: &'static Shape

The shape of this type, including: whether it’s a Struct, an Enum, something else?