Struct TokioSoeSocket 

pub struct TokioSoeSocket { /* private fields */ }

An async SOE socket: a SoeMultiplexer driven over a Tokio UDP socket.

Drive it by repeatedly awaiting step, which performs a single read-or-tick cycle and returns any SocketEvents produced. Sessions are initiated with connect and data is sent with enqueue_data.

Implementations

impl TokioSoeSocket

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

Binds a UDP socket to local and prepares to drive sessions, ticking every tick_period. A period of 1–10ms is typical.

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

Returns the local address the socket is bound to.

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

Performs a single drive cycle: awaits either an incoming datagram or the next tick, runs a session tick, flushes outgoing datagrams, and returns any events.

Trait Implementations

impl Debug for TokioSoeSocket

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

Formats the value using the given formatter.

impl SoeSocket for TokioSoeSocket

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.