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() -> DefaultWebSocketHandler
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§fn default() -> DefaultWebSocketHandler
fn default() -> DefaultWebSocketHandler
Returns the “default value” for a type. Read more
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
'life0: 'async_trait,
'life1: 'async_trait,
DefaultWebSocketHandler: '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
'life0: 'async_trait,
'life1: 'async_trait,
DefaultWebSocketHandler: 'async_trait,
fn on_disconnect<'life0, 'life1, 'async_trait>(
&'life0 self,
conn: &'life1 WebSocketConnection,
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
DefaultWebSocketHandler: 'async_trait,
fn authenticate(&self, token: &str) -> Result<i64, 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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more