Struct SyncSoeSocket 

pub struct SyncSoeSocket { /* private fields */ }

A synchronous SOE socket: a SoeMultiplexer driven over a blocking std::net::UdpSocket.

Drive it by repeatedly calling step, which performs a single read-or-tick cycle and returns any SocketEvents produced. The socket is given a read timeout equal to the tick period, so step returns promptly when a datagram arrives and otherwise wakes once per tick to run housekeeping.

Implementations

impl SyncSoeSocket

pub fn bind( local: SocketAddr, config: SocketConfig, tick_period: Duration, ) -> Result<Self>

Binds a UDP socket to local and prepares to drive sessions, waking at least once every tick_period to run housekeeping. A period of 1–10ms is typical.

pub fn step(&mut self) -> Result<Vec<SocketEvent<SocketAddr>>>

Performs a single drive cycle: waits up to the tick period for an incoming datagram, runs a session tick, flushes outgoing datagrams, and returns any events.

Trait Implementations

impl Debug for SyncSoeSocket

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

Formats the value using the given formatter.

impl SoeSocket for SyncSoeSocket

fn local_addr(&self) -> Result<SocketAddr>

Returns the local address the underlying socket is bound to.

fn session_count(&self) -> usize

Returns the number of active sessions.

fn connect(&mut self, remote: SocketAddr)

Opens a client session to remote. The session request is sent on the next drive step.

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

Enqueues application data to be sent reliably to remote. Returns false if there is no running session for that address.

fn terminate(&mut self, remote: &SocketAddr, reason: DisconnectReason)

Terminates the session with remote, notifying the remote party.