Struct WsConn 

pub struct WsConn<S> { /* private fields */ }

A per-connection WebSocket actor that bridges Gun protocol messages.

Created by crate::adapters::WsServer (inbound) or crate::adapters::OutgoingWebsocketManager (outbound). Each WsConn manages a single WebSocket connection and translates between the Gun wire format (text) and [Message] enum values. A per-connection WebSocket actor that bridges Gun protocol messages.

Generic over the underlying stream type S (plain TcpStream or TlsStream<TcpStream>). Created by crate::adapters::WsServer (inbound) or crate::adapters::OutgoingWebsocketManager (outbound). Each WsConn manages a single WebSocket connection and translates between the Gun wire format (text) and [Message] enum values.

Implementations

impl<S> WsConn<S>

where S: AsyncRead + AsyncWrite + Unpin + Send + 'static,

pub fn new(ws: WebSocketStream<S>, allow_public_space: bool) -> Self

Creates a new WsConn from a WebSocketStream.

Trait Implementations

impl<S> Actor for WsConn<S>

where S: AsyncRead + AsyncWrite + Unpin + Send + 'static,

fn handle<'life0, 'life1, 'async_trait>( &'life0 mut self, msg: Arc<Message>, ctx: &'life1 ActorContext, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Fallback single-message handler. Feeds one message then flushes. Used when the actor runtime calls handle instead of handle_batch.

fn handle_batch<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, batch: &'life1 mut Vec<Arc<Message>>, ctx: &'life2 ActorContext, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Batch handler — feeds all messages into the WS frame buffer without flushing. Because flush_threshold is set to usize::MAX, feed() never triggers an implicit flush and never blocks on I/O.

Flushing is handled by a dedicated background task spawned in pre_start, which calls flush() on a timer. This decouples the actor’s message processing from socket I/O — the actor never suspends waiting for the TCP buffer to drain.

Cooperative Scheduling

On current_thread runtime, feed() with flush_threshold(MAX) completes without suspending, so a full batch of 64 messages can be processed without yielding to other tasks. We call yield_now() every 16 messages to ensure the relay’s router and other actors get scheduled. Without this, on current_thread, a sender’s WsConn can starve the relay’s receive loop, causing a deadlock where the relay never processes incoming puts.

fn pre_start<'life0, 'life1, 'async_trait>( &'life0 mut self, ctx: &'life1 ActorContext, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called once before the actor starts processing messages.

fn stopping<'life0, 'life1, 'async_trait>( &'life0 mut self, _context: &'life1 ActorContext, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called once after the actor’s message loop exits.

fn subscribe_to_everything(&self) -> bool

Whether this actor wants to receive all messages (not just addressed to it). Used by the Multicast adapter.

fn try_clone_storage(&self) -> Option<Box<dyn Actor>>

Attempts to produce a clone of this actor for storage read/write splitting.