fq 项目技术文档

1. 安装指南

系统要求

• C 编译器
• GNU make
• libuuid
• sqlite3
• jlog
• libbcd（可选，用于崩溃跟踪）

安装步骤

通常情况下，安装步骤如下：

make
make install

如果不希望安装 libbcd 支持，可以使用以下命令：

NO_BCD=1 make

2. 项目的使用说明

fq 是一个基于发布订阅模型的代理消息队列，它被设计为高性能，目前并不支持大量连接的客户端。

终端术语

• Broker：fqd 进程，所有信息都通过这个守护进程。
• Peers：连接的 fqd 进程。需要注意的是，对等点是单向的。如果 A 与 B 建立对等关系，那么 A 将作为 B 的客户端。如果想要双向对等，必须指定 A 与 B 互为对等点。
• Client：客户端是应用程序通过 TCP/IP 与 fq 的连接，用于发送或接收消息。
• Exchanges：类似于公共汽车，消息可以在上面发送。
• Queues：队列是队列。如果你在队列的一端放入东西，你应该期望它从另一端出来。

消息和元数据

消息包括负载和元数据。元数据有些由经纪人设置，有些由发送者设置。

3. 项目 API 使用文档

API 使用文档将在以下部分详细说明。

HTTP superposition

Fq 协议还充当一个非合规的 HTTP 服务器（尽管对于大多数客户端和浏览器来说足够合规）。Fq附带一个网页界面，允许实时查看状态和性能。

GET /stats.json

该端点公开当前交换机、队列和客户端信息。

POST /submit

该端点允许在不进行完整和有状态的 Fq 连接的情况下提交消息。它期望以下请求头：

• X-Fq-User
• X-Fq-Route
• X-Fq-Exchange

HTTP 客户端必须提供与负载内容相对应的 Content-Length 头（不允许分块提交）。负载被视为原始消息框，不进行特殊编码。

示例：

curl -X POST -H "X-Fq-User: user" -H 'X-Fq-Route: bla' -H 'X-Fq-Exchange: test' localhost:8765/submit --data "TEST"

4. 项目安装方式

项目安装方式已在“安装指南”部分详细说明，包括系统要求和安装步骤。请按照上述步骤进行安装。