Expand description
wordval-ws:wordval 游戏服务器框架的 WebSocket 传输层。
提供连接管理、会话跟踪,以及与 axum 集成的 WebSocket 升级助手。
基于主题的发布/订阅见 [foxglove] 模块(feature foxglove)。
§快速上手
ⓘ
use wordval_ws::{ws_upgrade, ws_conns, ws_sessions, WsPlugin, WsMessage};
// 注册插件
let plugin_manager = PluginManager::new().add(WsPlugin);
plugin_manager.start_all().await?;
// 在 axum 路由中升级 WebSocket:
async fn ws_route(ws: WebSocketUpgrade, user_id: Query<u64>) -> impl IntoResponse {
ws_upgrade(ws, user_id.0)
}
// 在任意位置向用户发消息:
ws_conns().send_to_user(user_id, &WsMessage::text("hello"));Re-exports§
pub use connection::ConnectionManager;pub use message::Connection;pub use message::WsMessage;pub use session::SessionExpiredHandler;pub use session::SessionInfo;pub use session::SessionManager;
Modules§
- connection
- 连接管理器 — 全局单例,跟踪所有活跃的 WebSocket 连接。
- message
- WebSocket 消息类型与连接表示。
- session
- 会话管理器 — 跟踪已认证用户与其连接之间的绑定关系。
Structs§
- WsPlugin
- wordval 的 WebSocket 插件。
Constants§
- DEFAULT_
MAINTENANCE_ INTERVAL_ SECS - 后台维护任务默认间隔(秒)
- DEFAULT_
STALE_ TIMEOUT_ SECS - 连接被视为过期(无心跳)的超时(秒),应大于维护间隔以容忍至少一次心跳往返
- WS_
MAX_ MESSAGE_ SIZE - 单条入站 WebSocket 消息的最大字节数(防洪泛,默认 4 MiB)。
Functions§
- init_
ws_ infrastructure - 独立初始化 WebSocket 基础设施(连接/会话管理器 + 后台维护任务)。
- spawn_
maintenance_ task - 启动后台任务:周期性清理过期连接与过期会话。
- try_
ws_ conns - 尝试获取全局连接管理器的引用(未初始化时返回
None)。 - try_
ws_ sessions - 尝试获取全局会话管理器的引用(未初始化时返回
None)。 - ws_
conns - 全局 ConnectionManager 单例的便捷访问器。
- ws_
sessions - 全局 SessionManager 单例的便捷访问器。
- ws_
upgrade - 把 HTTP 请求升级为 WebSocket 连接。
- ws_
upgrade_ with_ handler - 把 HTTP 请求升级为 WebSocket 连接,并挂载自定义消息处理器。
Type Aliases§
- Message
Handler - 入站 WebSocket 消息的应用层处理器。