Struct WebSocketServer 

pub struct WebSocketServer<T>
where
    T: WebSocketHandler + Send + Sync + 'static,
{
    pub counters: Arc<WebSocketCounters>,
    pub handler: Arc<T>,
    pub stop: DuplexChannel,
}

WebSocketServer that provides the main websocket connection and message processing loop that delivers messages to the installed WebSocketHandler trait.

Fields

counters: Arc<WebSocketCounters>

Connection and bandwidth counters tracked by this server.

handler: Arc<T>

The user-supplied handler driving connection and message processing.

stop: DuplexChannel

Duplex channel used to signal and await server shutdown.

Implementations

impl<T> WebSocketServer<T>

where T: WebSocketHandler + Send + Sync + 'static,

pub fn new( handler: Arc<T>, counters: Option<Arc<WebSocketCounters>>, ) -> Arc<WebSocketServer<T>>

Creates a new server with the given handler, optionally sharing externally supplied WebSocketCounters (new default counters are created if None).

pub async fn bind( self: &Arc<WebSocketServer<T>>, addr: &str, ) -> Result<TcpListener, Error>

Binds a TCP listener to the given address, returning an Error::Listen if binding fails.

pub async fn listen( self: &Arc<WebSocketServer<T>>, listener: TcpListener, config: Option<WebSocketConfig>, ) -> Result<(), Error>

Runs the accept loop on the given listener, dispatching each accepted connection to the handler until stop() is signaled.

pub fn stop(&self) -> Result<(), Error>

Signals the running listen() loop to shut down.

pub async fn join(&self) -> Result<(), Error>

Awaits completion of the listen() loop after a stop signal.

pub async fn stop_and_join(&self) -> Result<(), Error>

Signals shutdown and waits for the listen loop to finish.

Trait Implementations

impl<T> WebSocketServerTrait for WebSocketServer<T>

where T: WebSocketHandler + Send + Sync + 'static,

fn bind<'life0, 'async_trait>( self: Arc<WebSocketServer<T>>, addr: &'life0 str, ) -> Pin<Box<dyn Future<Output = Result<TcpListener, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, WebSocketServer<T>: 'async_trait,

Binds a TCP listener to the given address.

fn listen<'async_trait>( self: Arc<WebSocketServer<T>>, listener: TcpListener, config: Option<WebSocketConfig>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where WebSocketServer<T>: 'async_trait,

Runs the accept loop on the given listener until stopped.

fn stop(&self) -> Result<(), Error>

Signals the running listen loop to shut down.

fn join<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, WebSocketServer<T>: 'async_trait,

Awaits completion of the listen loop after a stop signal.

fn stop_and_join<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, WebSocketServer<T>: 'async_trait,

Signals shutdown and waits for the listen loop to finish.