gevent-socketio Documentation Release 0.3.1

## gevent-socketio Documentation Release 0.3.1 总结 该文档主要介绍了 **gevent-socketio** 库的功能、集成方法和核心实现，以下是总结： ### 1. 服务器集成层 - **运行环境**：gevent-socketio 基于 Gevent，需使用 Gevent 的服务器以实现协作式多任务处理。 - **与 Gunicorn 集成**： - 通过 `socketio.sgunicorn` 模块实现，需在 Gunicorn 启动时指定工作类 `GeventSocketIOWorker`。 - 示例配置：`gunicorn --worker-class socketio.sgunicorn.GeventSocketIOWorker module:app`。 - **与 Pyramid/paster 集成**： - 使用 `[server:main]` 配置节，指定 `use = egg:gunicorn#main`，并配置 worker 类。 - 示例配置：`use = egg:gunicorn#main`，`worker_class = socketio.sgunicorn.GeventSocketIOWorker`。 - **直接通过 Gevent 集成**： - 无额外依赖，简洁高效。配置示例： ```ini [server:main] use = egg:gevent-socketio#paster host = 0.0.0.0 port = 6543 resource = socket.io transports = websocket, xhr-polling, xhr-multipart policy_server = True policy_listener_host = 0.0.0.0 policy_listener_port = 10843 ``` ### 2. 核心功能 - **虚拟套接字**： - **功能**：统一不同传输协议（如 WebSocket、XHR POLLING 等）接口，封装长轮询方法。虚拟套接字为每个客户端浏览器创建单一实例。 - **默认错误处理函数**：`default_error_handler`，可自定义以实现日志记录等功能。 - **命名空间（Namespace）**： - **定义**：为开发者提供的主要接口，需继承 `BaseNamespace` 类，自定义事件处理方法。 - **事件处理**：根据事件名称自动分发到相应的处理方法，如 `on_connect()`、`on_disconnect()` 等。也可处理完整数据包，定义事件处理器接收 `packet` 参数。 - **数据包处理**： - 支持的消息类型包括 `connect`、`message`、`json` 等。 - 示例： ```python {"type": "connect", "qs": "", "endpoint": "/chat"} {"type": "message", "data": "this is the sent string", "endpoint": "/chat"} {"type": "json", "data": {"this": "is a json object"}, "endpoint": "/chat"} ``` ### 3. 错误处理机制 - **默认错误处理函数**：`default_error_handler`，通过 Socket 发送 'error' 事件。 - **自定义错误处理**：可通过 `error_handler` 参数传入自定义处理函数。 ### 4. 核心模块 - **socketio**：提供 `socketio_manage` 主管理函数，用于框架集成。 - **virtsocket**：实现虚拟套接字，封装多种传输方式。 - **namespace**：定义 `BaseNamespace` 类，用于自定义事件处理逻辑。 - **packet**：处理 Socket.IO 协议的消息解码和封装。 - **server**：提供 `SocketIOServer` 类，用于整合 Gevent 和 WSGI 应用。 ### 5. 服务器配置选项 - **常用配置项**： - `host`、`port`：指定服务器监听地址和端口。 - `resource`：指定 Socket.IO 资源路径，默认为 `/socket.io/`。 - `transports`：允许的传输协议，可选项包括 `websocket`、`xhr-polling`、`xhr-multipart`、`htmlfile`。 - `policy_server`：控制是否启用 Flash 政策服务器，默认为 `True`。 - `policy_listener`：指定政策服务器的监听地址和端口，默认为 `0.0.0.0:843`。 - `heartbeat_interval` 和 `heartbeat_timeout`：配置心跳超时和心跳间隔，用于维持客户端连接状态。 ### 总结 文档详细介绍了 **gevent-socketio** 的服务器集成、核心功能、错误处理、核心模块以及服务器配置，提供了丰富的功能和配置选项，适用于构建高并发实时 web 应用。