Skip to main content

WsHandler

sz_rust_core::websocket_route

Trait WsHandler 

Source 
pub trait WsHandler:
    Send
    + Sync
    + 'static {
    // Provided methods
    fn on_connect(&self) { ... }
    fn on_message(&self, _msg: Message) -> Option<Message> { ... }
    fn on_close(&self) { ... }
}
Expand description

WebSocket 事件处理器 trait

对齐 PHP Workerman 的 onConnect / onMessage / onClose 事件模型。 用户实现此 trait，通过 ws_handler() 转为 axum handler。

Provided Methods§

Source

fn on_connect(&self)

连接建立时调用

默认空实现。可用于注册连接、发送欢迎消息等。

Source

fn on_message(&self, _msg: Message) -> Option<Message>

收到文本/二进制消息时调用

返回 Some(Message) 则自动回发给客户端，返回 None 则不回发。 默认返回 None。

Source

fn on_close(&self)

连接关闭时调用

默认空实现。可用于清理资源、广播离线通知等。

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§