pub struct DefaultWebSocketHandler { /* private fields */ }Expand description
Default WebSocket handler that tracks connections and echoes messages.
- Text messages are echoed back to the sender with the sender’s user_id.
- Ping messages are answered with a Pong.
- Subscribe/Unsubscribe/Join/Leave messages return a System acknowledgement.
- All other messages are logged but produce no response.
Implementations§
Source§impl DefaultWebSocketHandler
impl DefaultWebSocketHandler
pub fn new() -> Self
pub async fn connection_count(&self) -> usize
pub async fn is_connected(&self, connection_id: &str) -> bool
pub async fn message_count(&self) -> usize
pub async fn messages(&self) -> Vec<WebSocketMessage>
pub async fn get_connection( &self, connection_id: &str, ) -> Option<WebSocketConnection>
Trait Implementations§
Source§impl Default for DefaultWebSocketHandler
impl Default for DefaultWebSocketHandler
Source§impl WebSocketHandler for DefaultWebSocketHandler
impl WebSocketHandler for DefaultWebSocketHandler
fn on_message<'life0, 'life1, 'async_trait>(
&'life0 self,
conn: &'life1 WebSocketConnection,
msg: WebSocketMessage,
) -> Pin<Box<dyn Future<Output = Result<Option<WebSocketMessage>, WsError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn on_connect<'life0, 'life1, 'async_trait>(
&'life0 self,
conn: &'life1 WebSocketConnection,
) -> Pin<Box<dyn Future<Output = Result<(), WsError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn on_disconnect<'life0, 'life1, 'async_trait>(
&'life0 self,
conn: &'life1 WebSocketConnection,
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn authenticate(&self, token: &str) -> Result<UserId, WsError>
Auto Trait Implementations§
impl !RefUnwindSafe for DefaultWebSocketHandler
impl !UnwindSafe for DefaultWebSocketHandler
impl Freeze for DefaultWebSocketHandler
impl Send for DefaultWebSocketHandler
impl Sync for DefaultWebSocketHandler
impl Unpin for DefaultWebSocketHandler
impl UnsafeUnpin for DefaultWebSocketHandler
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more