websockets Documentation Release 2.2

• 语言: 英语
• 格式: .pdf
• 来源: websockets.readthedocs.io

摘要

文档详细介绍了websockets库版本2.2.0的功能和使用方法。该库提供了完整的WebSocket协议实现，包括客户端和服务器端的API。文档重点阐述了WebSocket协议的两个主要阶段：握手过程和数据传输过程。此外，文档还介绍了如何处理异常情况、验证请求和响应头，以及如何通过简单的API实现协议的核心功能。版本更新部分提到了新增的消息大小限制、支持原点验证等功能。

AI总结

# websockets 文档总结（版本 2.2）

## 概述
websockets 是一个基于 asyncio 的 WebSocket 库，提供了完整的客户端和服务器实现，支持 WebSocket 协议的两个主要阶段：
1. **握手阶段**：通过 HTTP 升级请求建立连接。
2. **数据传输阶段**：通过帧消息进行数据传输，最终通过关闭握手结束连接。

## 核心功能

### 1. API 分层
- **高级 API**：
- **服务器端**：`websockets.server.serve()`，用于创建 WebSocket 服务器，接受客户端连接并处理请求。
- **客户端**：`websockets.client.connect()`，用于连接 WebSocket 服务器，发送和接收消息。
- **共享模块**：`websockets.protocol`，处理 WebSocket 控制帧和数据帧，继承自 `WebSocketCommonProtocol`。

- **低级 API**：
- 提供底层协议实现，包括异常处理、握手、数据传输等。

### 2. 手册变更
- **2.2 版本**：
- 新增消息大小限制功能。
- **2.1 版本**：
- 新增 `host`、`port` 和 `secure` 属性。
- 支持提供和验证 `Origin` 头。
- **2.0 版本**：
- 不兼容的 API 变更：`send()`、`ping()` 和 `pong()` 方法从函数变为异步函数。
- 新增流量控制功能。
- **1.0 版本**：
- 初始公开版本。

### 3. 限制
- WebSocket 服务器不支持直接关闭连接，需等待服务器完成关闭握手。

### 4. 许可证
- 未在文档中明确说明，但假设为 MIT 许可证或其他开源许可证。

## 总结
websockets 库通过简洁的 API 实现了 WebSocket 协议的核心功能，适用于需要实时双向通信的应用场景。2.2 版本新增了消息大小限制，2.1 版本增强了对 `Origin` 头的支持，2.0 版本引入了流量控制机制，而 1.0 版本则是初始公开版本。开发者可以根据需求选择合适的版本，并通过高级或低级 API 快速构建 WebSocket 应用。