Enum SessionMessage 

pub enum SessionMessage {
    OnMessage {
        message: ProtoMessage,
        direction: MessageDirection,
        ack_tx: Option<Sender<Result<(), SessionError>>>,
    },
    MessageError {
        error: SessionError,
    },
    TimerTimeout {
        message_id: u32,
        message_type: ProtoSessionMessageType,
        name: Option<EncodedName>,
        timeouts: u32,
    },
    TimerFailure {
        message_id: u32,
        message_type: ProtoSessionMessageType,
        name: Option<EncodedName>,
        timeouts: u32,
    },
    ParticipantDisconnected {
        name: Option<ProtoName>,
    },
    StartDrain {
        grace_period: Duration,
    },
    DeleteSession {
        session_id: u32,
    },
    GetParticipantsList {
        tx: Sender<Vec<ProtoName>>,
    },
    LeaveCleanup,
}

Message types for communication between session components

Variants

OnMessage

application message coming from the app or from slim

Fields

message: ProtoMessage

direction: MessageDirection

ack_tx: Option<Sender<Result<(), SessionError>>>

Optional channel to signal when message processing is complete

MessageError

Error occurred during message processing

Fields

error: SessionError

TimerTimeout

timeout signal for a message (ack,rtx or control messages) that needs to be send again

Fields

message_id: u32

message_type: ProtoSessionMessageType

name: Option<EncodedName>

timeouts: u32

TimerFailure

timer failure, signal to the owner of the packet that the message will not be delivered

Fields

message_id: u32

message_type: ProtoSessionMessageType

name: Option<EncodedName>

timeouts: u32

ParticipantDisconnected

sent by the controller sender when a disconnection is detected

Fields

name: Option<ProtoName>

StartDrain

message from session layer to the session controller to start to the close procedures of the session

Fields

grace_period: Duration

DeleteSession

message from session controller to session layer to notify that the session can be removed safely

Fields

session_id: u32

GetParticipantsList

Query the participants list from the handler

Fields

tx: Sender<Vec<ProtoName>>

LeaveCleanup

Deferred cleanup after leave reply has been dispatched. Performs route/subscription cleanup that must happen after the LeaveReply is sent (in the return-based output model, dispatch happens after on_message returns).

Trait Implementations

impl Debug for SessionMessage

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

Formats the value using the given formatter.