Struct WebSocketState 

pub struct WebSocketState { /* private fields */ }

WebSocket connection state manager.

Each connection has an outgoing queue of message_buffer_size messages; messages for a client whose queue is full are dropped rather than buffered without bound.

Implementations

impl WebSocketState

pub fn new(config: WebSocketConfig) -> Self

pub fn config(&self) -> &WebSocketConfig

The configuration the state was created with.

pub async fn serve_connection( state: Arc<RwLock<WebSocketState>>, websocket: WebSocket, ) -> Result<()>

Serve one WebSocket connection until it closes.

The shared state is only locked for the short moments that register the connection, handle a client message and unregister it, never while waiting for the client: a connection that held the lock for its whole lifetime would block every other connection, the ping task and the broadcast listener.

pub async fn broadcast_to_all(&self, message: ServerMessage) -> Result<()>

Broadcast a message to all connected clients

pub async fn broadcast_to_subscribed( &self, message: ServerMessage, event_type: &str, ) -> Result<()>

Broadcast a message to the clients subscribed to event_type

pub async fn publish_archive_event(&self, event: ArchiveEvent) -> Result<()>

Publish an archive event to all connected clients

pub async fn ping_all_connections(&self)

Send ping to all connections to keep them alive

pub fn connection_count(&self) -> usize

Get current connection count

pub async fn start_broadcast_listener( state: Arc<RwLock<WebSocketState>>, ) -> Result<()>

Start the broadcast listener task

Trait Implementations

impl Debug for WebSocketState

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

Formats the value using the given formatter.