cWebsocket 技术文档

1. 安装指南

cWebsocket 是一个轻量级的 C 语言编写的 WebSocket 服务器库。以下是安装步骤：

1. 克隆项目到本地：

   git clone https://github.com/your-username/cWebsocket.git
   

2. 进入项目目录：

   cd cWebsocket
   

3. 编译库：

   make
   

4. 将生成的库文件（通常是 .lib 或 .a 文件）复制到你的项目目录中。

2. 项目的使用说明

cWebsocket 库提供了一个简单的 API，用于创建和运行 WebSocket 服务器。以下是一个简单的使用示例：

#include "cWebsocket.h"

void on_message(ws_client_t *client, uint8_t *message, size_t len) {
    // 处理接收到的消息
    printf("Client %d: %.*s\n", client->id, len, message);
}

void on_new_connection(ws_client_t *client) {
    // 处理新连接
    printf("New connection: Client %d\n", client->id);
}

void on_client_disconnect(ws_client_t *client) {
    // 处理客户端断开连接
    printf("Client %d disconnected\n", client->id);
}

int main() {
    ws_server_t *server = ws_server_new(8080);
    ws_server_set_on_message(server, on_message);
    ws_server_set_on_new_connection(server, on_new_connection);
    ws_server_set_on_client_disconnect(server, on_client_disconnect);
    
    ws_server_run(server);
    
    ws_server_free(server);
    return 0;
}

在这个例子中，我们创建了一个 WebSocket 服务器，监听 8080 端口，并注册了消息处理函数。

3. 项目API使用文档

以下是一些核心 API 函数的简要说明：

• ws_server_new(int port)：创建一个新的 WebSocket 服务器，监听指定端口。
• ws_server_free(ws_server_t *server)：释放 WebSocket 服务器的资源。
• ws_server_run(ws_server_t *server)：运行 WebSocket 服务器。
• ws_server_set_on_message(ws_server_t *server, ws_message_handler handler)：设置消息处理函数。
• ws_server_set_on_new_connection(ws_server_t *server, ws_new_connection_handler handler)：设置新连接处理函数。
• ws_server_set_on_client_disconnect(ws_server_t *server, ws_client_disconnect_handler handler)：设置客户端断开连接处理函数。

更多 API 函数和详细信息请参考项目源代码。

4. 项目安装方式

项目的安装方式已在“安装指南”中说明。简要步骤如下：

1. 克隆项目到本地。
2. 进入项目目录。
3. 编译库。
4. 将生成的库文件复制到你的项目目录中。