Struct RealtimeSession 

pub struct RealtimeSession { /* private fields */ }

A live realtime WebSocket session.

Wraps the underlying WebSocket stream and exposes JSON send/receive.

Implementations

impl RealtimeSession

pub async fn send(&mut self, event: Value) -> Result<(), RealtimeError>

Send a JSON event as a text frame.

Not cancel-safe: dropping this future mid-flight (e.g. racing it in tokio::select!) can leave a partial frame on the connection. Let it run to completion.

pub async fn recv(&mut self) -> Result<Option<Value>, RealtimeError>

Receive the next JSON event.

Returns Ok(None) on a clean close. Ping/Pong frames are handled automatically by the underlying library and skipped here; non-text frames other than binary JSON are skipped as well. This method is cancel-safe. Keep polling it even when idle — server pings are only answered while a read is in progress, and an unpolled session may be dropped by the server.

pub async fn close(self) -> Result<(), RealtimeError>

Close the connection with a normal closure handshake.