neforce::http::websocket_server类 参考

WebSocket服务器类 更多...

#include <websocket.hpp>

Public 类型
using	session_ptr = shared_ptr<websocket_session>
	会话智能指针类型
using	session_handler = function<void(session_ptr)>
	会话处理器类型

Public 成员函数
void	set_io_context (io_context &ctx) noexcept
	设置异步 I/O 执行上下文
void	route (const string &path, session_handler handler)
	注册WebSocket路由
bool	handle_upgrade (const http_request &request, unique_ptr< tcp_socket > sock)
	处理WebSocket升级请求
void	remove_session (const session_ptr &session)
	移除会话
void	broadcast (const string &data, websocket_opcode opcode=websocket_opcode::TEXT)
	向所有会话广播消息
size_t	session_count () const noexcept
	获取活动会话数量

详细描述

WebSocket服务器类

管理WebSocket路由和会话，处理协议升级请求。

使用示例：

websocket_server ws_server;
ws_server.route("/chat", [](websocket_server::session_ptr session) {
    session->set_message_handler([](const string& msg, websocket_opcode opcode) {
        println("Received: ", msg);
        session->send("Echo: " + msg);
    });
});
 
// 在HTTP服务器中处理升级请求
if (request.method == http_method::GET() && request.header("Upgrade") == "websocket") {
    if (ws_server.handle_upgrade(request, move(socket))) {
        return; // 连接已升级为WebSocket
    }
}

在文件 websocket.hpp 第 135 行定义.

成员函数说明

broadcast()

void neforce::http::websocket_server::broadcast	(	const string &	data,
		websocket_opcode	opcode = websocket_opcode::TEXT )

向所有会话广播消息

参数

data	消息数据
opcode	操作码（默认TEXT）

引用了 neforce::data() , 以及 TEXT.

handle_upgrade()

bool neforce::http::websocket_server::handle_upgrade	(	const http_request &	request,
		unique_ptr< tcp_socket >	sock )

处理WebSocket升级请求

参数

request	HTTP升级请求
sock	已建立的TCP/SSL socket

返回

成功创建会话返回true，未找到对应路由返回false

remove_session()

void neforce::http::websocket_server::remove_session

(

const session_ptr &

session

)

移除会话

参数

session

要移除的会话

route()

void neforce::http::websocket_server::route ( const string & path, session_handler handler )

inline

注册WebSocket路由

参数

path	路由路径
handler	会话处理器

在文件 websocket.hpp 第 170 行定义.

引用了 neforce::move().

session_count()

size_t neforce::http::websocket_server::session_count ( ) const

inlinenoexcept

获取活动会话数量

返回

会话数量

在文件 websocket.hpp 第 198 行定义.

set_io_context()

void neforce::http::websocket_server::set_io_context ( io_context & ctx )

inlinenoexcept

设置异步 I/O 执行上下文

参数

ctx	io_context 引用

设置后，新创建的 WebSocket 会话将使用 io_context 驱动 I/O 替代默认的线程模式。

在文件 websocket.hpp 第 163 行定义.

引用了 set_io_context().

被这些函数引用 set_io_context().

---

该类的文档由以下文件生成:

• websocket.hpp