Wslay WebSocket 库技术文档

1. 安装指南

1.1 系统要求

在安装 Wslay 之前，请确保您的系统满足以下要求：

• Sphinx：用于生成 man 页面。
• CUnit：版本 >= 2.1，用于构建和运行单元测试程序。
• Nettle：版本 >= 2.4，用于构建和运行示例程序。

1.2 从 Git 仓库构建

如果您从 Git 仓库获取 Wslay 源代码，请按照以下步骤进行构建：

1. 确保您的系统上安装了 autoconf 版本 >= 2.68。
2. 运行以下命令来生成配置文件并构建项目：

   $ autoreconf -i
   $ automake
   $ autoconf
   $ ./configure
   $ make
   

2. 项目的使用说明

2.1 事件驱动 API

Wslay 提供了两种级别的 API：事件驱动 API 和帧级别的低级 API。事件驱动 API 适用于非阻塞的反应器模式风格。您可以在各种事件中设置回调函数。

2.2 帧级别 API

帧级别的 API 允许您直接发送 WebSocket 帧。Wslay 仅支持 WebSocket 协议的数据传输部分，不执行 HTTP 的握手操作。

2.3 支持的功能

Wslay 支持以下功能：

• 文本/二进制消息
• 自动 ping 回复
• 回调接口
• 外部事件循环

3. 项目 API 使用文档

3.1 事件驱动 API

事件驱动 API 允许您在 WebSocket 连接的不同阶段设置回调函数。以下是一些常用的回调函数：

• on_message_begin：在接收到消息开始时调用。
• on_message_data：在接收到消息数据时调用。
• on_message_end：在接收到消息结束时调用。

3.2 帧级别 API

帧级别 API 允许您直接操作 WebSocket 帧。以下是一些常用的函数：

• wslay_event_queue_msg：将消息帧排队以发送。
• wslay_event_recv：接收 WebSocket 帧。
• wslay_event_send：发送 WebSocket 帧。

4. 项目安装方式

4.1 从源代码安装

如果您从源代码安装 Wslay，请按照以下步骤操作：

1. 克隆 Git 仓库：

   $ git clone https://github.com/tatsuhiro-t/wslay.git
   

2. 进入项目目录并构建：

   $ cd wslay
   $ autoreconf -i
   $ automake
   $ autoconf
   $ ./configure
   $ make
   $ sudo make install
   

4.2 使用包管理器安装

某些操作系统可能提供了 Wslay 的包管理器安装方式。请查阅您操作系统的包管理器文档以获取更多信息。

---

通过以上步骤，您可以成功安装并使用 Wslay WebSocket 库。希望这篇文档能帮助您更好地理解和使用该项目。