开源通信核心(Open Source Core)
Flare 提供 可独立集成 的三层开源栈:传输 → 服务端 → 客户端 SDK。按本节文档可在数小时内完成选型与首条消息联调。
三件核心
| 仓库 | 许可 | 角色 | 文档入口 |
|---|---|---|---|
| flare-core | Apache-2.0 | WebSocket / QUIC、协商、心跳 | 概览 · 快速开始 · API |
| flare-im-core | Apache-2.0 | 消息编排、会话、存储、同步 | 概览 · 本地部署 |
| flare-im-core-sdk | Apache-2.0 | IMClient、同步、本地库、FFI | 概览 · API |
契约:flare-proto(gRPC / Protobuf,与 monorepo 同源)。
推荐学习路径
1. 读 01 矩阵 + 08 协议语义(seq / cursor)
2. 按 07 选路径 A / B / C
3. 跑通 03 或 05 + SDK 02-quickstart
4. 查 09 / 10 API,深入 /docs/sdk 专册
文档索引
| 文档 | 内容 |
|---|---|
| 01-open-source-matrix | 依赖、许可、边界 |
| 02–03 flare-core | 传输层 |
| 04–05 flare-im-core | 服务端 |
| 06 SDK 概览 | 客户端分层 |
| 07-integration-paths | 三条集成路径 |
| 08-protocol-semantics | request_id / message_id / seq / cursor |
| 09-flare-core-api | flare-core API |
| 10-sdk-api-reference | IMClient 与 Facade |
专册
| 分区 | 说明 |
|---|---|
| /docs/sdk | 连接、消息、会话、同步、事件 |
| /docs/server | 微服务、Compose、gRPC、客户端默认端口 |
能力速览
- 消息顺序:会话
seq单调递增,禁止回退 - 增量同步:
sync_messages(conv, last_seq),非 offset 分页 - 事件驱动:JetStream 串联编排与存储
- 多端:cursor 合并、离线回放
- 可嵌入:仅 flare-core 或完整 SDK + 自建/托管后端