Webby 技术文档

Webby 是一款专为游戏内部调试或其他持续运行的主循环程序设计的简易 Web 服务器。当您需要一个轻量级的解决方案而性能不是主要关注点时，它可以派上用场。

1. 安装指南

Webby 的安装过程相对直接。由于它是一个固定内存的服务器，您需要根据您的需求分配足够的内存。

步骤：

1. 确定您的程序需要的内存大小，通过调用 WebbyServerMemoryNeeded() 函数计算。
2. 分配相应大小的内存（可以使用静态字符数组）。
3. 使用 WebbyServerInit() 函数初始化服务器。
4. 在游戏的每一帧调用 WebbyServerUpdate() 函数。
5. 当需要关闭服务器时，调用 WebbyServerShutdown() 函数。

2. 项目的使用说明

Webby 的使用非常直观。以下是基本的步骤：

• 填充 WebbyServerConfig 结构体。
• 计算内存需求。
• 分配内存。
• 初始化服务器。
• 每一帧更新服务器状态。
• 在服务器配置中提供请求分发函数。
• 处理请求并生成响应。

3. 项目API使用文档

以下是 Webby 提供的一些关键 API 函数及其用途：

• WebbyServerMemoryNeeded(): 计算服务器所需的内存大小。
• WebbyServerInit(): 初始化服务器。
• WebbyServerUpdate(): 更新服务器状态，每帧调用一次。
• WebbyServerShutdown(): 关闭服务器。
• WebbyBeginResponse(): 开始生成响应。
• WebbyWrite(): 写入响应数据。
• WebbyEndResponse(): 结束响应。

WebSocket 使用

• 在初始化时提供 WEBBY_SERVER_WEBSOCKETS 标志。
• 在 ws_connect 处理函数中决定是否允许 WebSocket 升级请求。
• 连接建立后，ws_connected 处理函数会被调用。
• 接收到的帧数据会通过 ws_frame 处理函数传递。
• 使用 WebbyRead() 读取帧数据，注意不要读取超过指定的数据量。
• 使用 WebbyBeginSocketFrame() 和 WebbyWrite() 发送 WebSocket 数据。
• 连接关闭时，ws_closed 处理函数会被调用。

4. 项目安装方式

Webby 的安装方式如上所述，主要涉及内存分配和初始化函数的调用。请确保您的程序能够提供足够的内存，并根据需要调用相应的更新和关闭函数。

以上文档概述了如何安装和使用 Webby 服务器，以及如何通过其 API 与服务器交互。请根据您的具体需求调整和使用这些指南。