WebSocketServer

Struct WebSocketServer 

Source
pub struct WebSocketServer { /* private fields */ }
Expand description

WebSocket server - integrates with elif HTTP server

Implementations§

Source§

impl WebSocketServer

Source

pub fn new() -> Self

Create a new WebSocket server

Source

pub fn with_config(config: WebSocketConfig) -> Self

Create with custom configuration

Source

pub fn registry(&self) -> Arc<ConnectionRegistry>

Get the connection registry

Source

pub async fn stats(&self) -> RegistryStats

Get server statistics

Source

pub fn add_websocket_route<F, Fut>( &self, router: ElifRouter, path: &str, _handler: F, ) -> ElifRouter
where F: Fn(ConnectionId, Arc<WebSocketConnection>) -> Fut + Send + Sync + Clone + 'static, Fut: Future<Output = ()> + Send + 'static,

Add a WebSocket route to the router using a simple closure For now, this is a placeholder that will be improved in later iterations

Source

pub fn add_handler<F, Fut>( &self, router: ElifRouter, path: &str, handler: F, ) -> ElifRouter
where F: Fn(ConnectionId, Arc<WebSocketConnection>) -> Fut + Send + Sync + Clone + 'static, Fut: Future<Output = ()> + Send + 'static,

Add a simple WebSocket handler function (alias for add_websocket_route)

Source

pub async fn broadcast(&self, message: WebSocketMessage) -> BroadcastResult

Broadcast a message to all connections

Source

pub async fn broadcast_text<T: Into<String>>(&self, text: T) -> BroadcastResult

Broadcast text to all connections

Source

pub async fn broadcast_binary<T: Into<Vec<u8>>>( &self, data: T, ) -> BroadcastResult

Broadcast binary data to all connections

Source

pub async fn send_to_connection( &self, id: ConnectionId, message: WebSocketMessage, ) -> WebSocketResult<()>

Send a message to a specific connection

Source

pub async fn send_text_to_connection<T: Into<String>>( &self, id: ConnectionId, text: T, ) -> WebSocketResult<()>

Send text to a specific connection

Source

pub async fn send_binary_to_connection<T: Into<Vec<u8>>>( &self, id: ConnectionId, data: T, ) -> WebSocketResult<()>

Send binary data to a specific connection

Source

pub async fn get_connection_ids(&self) -> Vec<ConnectionId>

Get all active connection IDs

Source

pub async fn connection_count(&self) -> usize

Get the number of active connections

Source

pub async fn close_connection(&self, id: ConnectionId) -> WebSocketResult<()>

Close a specific connection

Source

pub async fn close_all_connections(&self) -> CloseAllResult

Close all connections

Source

pub fn start_cleanup_task(&mut self, interval_seconds: u64)

Start the cleanup task for inactive connections

Source

pub fn stop_cleanup_task(&mut self)

Stop the cleanup task

Trait Implementations§

Source§

impl Default for WebSocketServer

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Drop for WebSocketServer

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,