Zerogw 技术文档

1. 安装指南

1.1 Ubuntu 系统安装

在 Ubuntu 系统上，可以通过以下命令安装 Zerogw：

sudo add-apt-repository ppa:tailhook/zerogw
sudo apt-get update
sudo apt-get install zerogw

1.2 ArchLinux 系统安装

在 ArchLinux 系统上，可以通过以下命令安装 Zerogw：

yaourt -S zerogw

1.3 其他 Linux 发行版安装

对于其他 Linux 发行版，请参考编译部分进行安装。

2. 项目使用说明

Zerogw 是一个 HTTP 到 ZeroMQ 的网关，它监听 HTTP 请求，解析请求并使用 ZeroMQ 套接字（ZMQ_REQ）发送请求，然后等待回复并将从 ZeroMQ 套接字接收到的数据响应给客户端。

从 v0.3 版本开始，Zerogw 还支持 WebSocket。WebSocket 通过使用 ZMQ_PUB 套接字转发传入的消息，并使用 ZMQ_SUB 套接字监听命令来实现。每个 WebSocket 客户端可以订阅无限数量的主题。每个 ZeroMQ 消息要么是控制消息（例如订阅），要么是发送到指定主题的消息，该消息将高效地发送给订阅了该特定主题的每个 WebSocket。

Zerogw 是用 C 语言编写的，并使用 libwebsite 库来处理 HTTP（libwebsite 本身使用 libev）。

Zerogw 不是一个全功能的 HTTP 服务器。它对静态文件、缓存、CGI 等一无所知。它只知道一些路由，这使得它非常快速且具有完美的可扩展性。

使用场景

• RPC
• REST API
• Ajax
• WebSocket

3. 项目 API 使用文档

3.1 HTTP 请求处理

Zerogw 处理 HTTP 请求并将其转换为 ZeroMQ 消息。HTTP 请求的路由和处理由 libwebsite 库负责。

3.2 WebSocket 支持

Zerogw 支持 WebSocket，通过 ZMQ_PUB 和 ZMQ_SUB 套接字实现消息的转发和订阅。每个 WebSocket 客户端可以订阅多个主题，Zerogw 会将消息高效地发送给订阅了相应主题的客户端。

3.3 控制消息

控制消息用于管理 WebSocket 客户端的订阅和取消订阅操作。

4. 项目安装方式

4.1 依赖项

Zerogw 的运行需要以下依赖项：

• Linux 内核版本至少为 2.6.28（需要 accept4）
• libwebsite：用于处理 HTTP
• coyaml：用于处理配置
• python3：coyaml 需要 python3 来构建配置解析器
• libzmq 和 libev：ZeroMQ 和事件循环库
• libyaml：用于解析配置

前两个库通常是静态编译的，因此运行时不需要它们。python3 也是如此。

4.2 编译安装

在其他 Linux 发行版上，可以通过以下步骤进行编译安装：

./waf configure --prefix=/usr
./waf build
./waf install

通过以上步骤，您可以成功安装并使用 Zerogw 项目。