Struct SoeSession 

pub struct SoeSession { /* private fields */ }

an I/O-agnostic handler for a single SOE protocol session.

Implementations

impl SoeSession

pub fn new( mode: SessionMode, params: SessionParameters, app: ApplicationParameters, rng_seed: u64, now: Instant, ) -> Self

Creates a new session handler in the SessionState::Negotiating state.

rng_seed seeds the generator used for the session ID (client) and CRC seed (server); pass a fixed value for deterministic behaviour, or entropy for real sessions.

pub fn state(&self) -> SessionState

Returns the current session state.

pub fn mode(&self) -> SessionMode

Returns the session mode.

pub fn session_id(&self) -> u32

Returns the negotiated session ID.

pub fn crc_seed(&self) -> u32

Returns the negotiated CRC seed (meaningful once running).

pub fn termination_reason(&self) -> DisconnectReason

Returns the reason the session terminated (meaningful once terminated).

pub fn terminated_by_remote(&self) -> bool

Returns whether the termination was initiated by the remote party.

pub fn take_outgoing(&mut self) -> Vec<Bytes>

Drains datagrams that the caller should send to the remote.

pub fn take_received(&mut self) -> Vec<Bytes>

Drains application data received from the remote.

pub fn take_events(&mut self) -> Vec<SessionEvent>

Drains session lifecycle events.

pub fn send_session_request(&mut self)

Sends a SessionRequest to begin negotiation. Only valid in client mode while negotiating.

pub fn enqueue_data(&mut self, data: &[u8]) -> bool

Enqueues application data to be sent reliably. Returns false if the session is not running.

pub fn terminate( &mut self, reason: DisconnectReason, notify_remote: bool, now: Instant, )

Terminates the session, optionally notifying the remote.

pub fn process_incoming(&mut self, datagram: Bytes, now: Instant)

Processes a single incoming datagram from the remote.

pub fn run_tick(&mut self, now: Instant)

Runs a single tick of the session: heartbeats, inactivity timeout, and the reliable data channels.

Trait Implementations

impl Debug for SoeSession

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

Formats the value using the given formatter.