Enum Frame 

pub enum Frame {
    Hello,
    Welcome {
        session_id: SessionId,
    },
    SessionRejected {
        code: ErrorCode,
        message: String,
    },
    Publish {
        request_id: u64,
        destination: Destination,
        access_token: BearerToken,
    },
    Published {
        request_id: u64,
        binding_id: BindingId,
    },
    PublishFailed {
        request_id: u64,
        code: ErrorCode,
        message: String,
    },
    Unpublish {
        request_id: u64,
        binding_id: BindingId,
    },
    Unpublished {
        request_id: u64,
    },
    Dial {
        connection_id: u64,
        destination: Destination,
        access_token: BearerToken,
    },
    Offer {
        pipe_id: PipeId,
        binding_id: BindingId,
        destination: Destination,
    },
    OfferAccepted {
        pipe_id: PipeId,
    },
    OfferRejected {
        pipe_id: PipeId,
        code: ErrorCode,
        message: String,
    },
    Opened {
        pipe_id: PipeId,
    },
    DialFailed {
        connection_id: u64,
        code: ErrorCode,
        observation: PeerObservation,
        message: String,
    },
    Data {
        pipe_id: PipeId,
        payload: Bytes,
    },
    Fin {
        pipe_id: PipeId,
    },
    Close {
        pipe_id: PipeId,
    },
    Reset {
        pipe_id: PipeId,
        code: ErrorCode,
        message: String,
    },
    Ping {
        nonce: u64,
    },
    Pong {
        nonce: u64,
    },
    Cancel {
        pipe_id: PipeId,
    },
}

Wire messages exchanged within one SDK–Gateway session.

Credentials are operation-scoped and appear only in Frame::Publish and Frame::Dial; application data remains opaque in Frame::Data.

Variants

Hello

SDK → Gateway: starts a session and carries no credential.

Welcome

Gateway → SDK: establishes the session and assigns its identifier.

Fields

session_id: SessionId

Identifies the session incarnation the Gateway just established.

SessionRejected

Gateway → SDK: refuses the session before it is established.

Fields

code: ErrorCode

Names the reason the session was refused.

message: String

Human-readable detail for the code.

Publish

SDK → Gateway: registers a Destination for this session.

Fields

request_id: u64

Correlates the reply with the request that carried the same id.

destination: Destination

The exact routing address being registered.

access_token: BearerToken

Operation credential the Gateway verifies for this registration.

Published

Gateway → SDK: reports that the registration succeeded.

Fields

request_id: u64

Correlates the reply with the request that carried the same id.

binding_id: BindingId

Identifies the Binding the registration created.

PublishFailed

Gateway → SDK: reports that the registration failed.

Fields

request_id: u64

Correlates the reply with the request that carried the same id.

code: ErrorCode

Names the reason the registration failed.

message: String

Human-readable detail for the code.

Unpublish

SDK → Gateway: releases a Binding this session owns.

Fields

request_id: u64

Correlates the reply with the request that carried the same id.

binding_id: BindingId

Identifies the Binding to release.

Unpublished

Gateway → SDK: confirms that the Binding is released.

Fields

request_id: u64

Correlates the reply with the request that carried the same id.

Dial

SDK → Gateway: requests a Pipe to a Destination.

Fields

connection_id: u64

Session-local id that correlates the dial with its terminal result.

destination: Destination

The exact routing address the dial targets.

access_token: BearerToken

Operation credential the Gateway verifies for this dial.

Offer

Offers an incoming Pipe to the session that owns a selected binding.

Fields

pipe_id: PipeId

Identifies the Pipe being offered.

binding_id: BindingId

Identifies the Binding the Gateway selected for the dial.

destination: Destination

The routing address the dial targeted.

OfferAccepted

SDK → Gateway: the Listener admitted the offered Pipe to its queue.

Fields

pipe_id: PipeId

Identifies the offered Pipe.

OfferRejected

SDK → Gateway: the Listener did not admit the offered Pipe.

Fields

pipe_id: PipeId

Identifies the offered Pipe.

code: ErrorCode

Names the reason the offer was rejected.

message: String

Human-readable detail for the code.

Opened

Confirms that a Pipe is established for the dialing session.

Fields

pipe_id: PipeId

Identifies the established Pipe, carrying the origin session id and the connection id of the dial that created it.

DialFailed

Gateway → SDK: ends a dial attempt without a Pipe.

Fields

connection_id: u64

Correlates the failure with the dial that carried the same id.

code: ErrorCode

Names the reason the dial failed.

observation: PeerObservation

States whether the selected Listener may have observed the dial.

message: String

Human-readable detail for the code.

Data

Carries opaque application bytes over an established Pipe.

Fields

pipe_id: PipeId

Identifies the Pipe the bytes belong to.

payload: Bytes

Application bytes RelayGate relays without interpreting them.

Fin

Half-closes the sender’s write direction of a Pipe.

Fields

pipe_id: PipeId

Identifies the Pipe being half-closed.

Close

Closes a Pipe normally in both directions.

Fields

pipe_id: PipeId

Identifies the Pipe being closed.

Reset

Terminates a Pipe with an error.

Fields

pipe_id: PipeId

Identifies the Pipe being terminated.

code: ErrorCode

Names the reason the Pipe was terminated.

message: String

Human-readable detail for the code.

Ping

Probes session liveness and expects a matching Frame::Pong.

Fields

nonce: u64

Value the peer echoes in its reply.

Pong

Answers a liveness probe.

Fields

nonce: u64

Echoes the nonce of the probe being answered.

Cancel

Cancels a pending Pipe establishment attempt.

Fields

pipe_id: PipeId

Identifies the pending Pipe to release.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl Encoder<Frame> for FrameCodec

type Error = ProtocolError

The type of encoding errors.

fn encode( &mut self, item: Frame, destination: &mut BytesMut, ) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.

impl Eq for Frame

impl PartialEq for Frame

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Frame