Skip to content

Commit e60e366

Browse files
authored
[ISSUE #2] explain develop plan (#3)
1 parent f7de459 commit e60e366

File tree

2 files changed

+56
-1
lines changed

2 files changed

+56
-1
lines changed

README-zh_cn.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# rocketmq-rust
2+
3+
Rocketmq非官方的Rust实现
4+
5+
## 模块
6+
7+
现有的Rocketmq主要有如下几个功能模块:
8+
9+
- **Name Server**
10+
- **Broker**
11+
- **Store(存储-本地)**
12+
- **Controller(高可用)**
13+
- **Client(SDK)**
14+
- **Proxy(代理)**
15+
- **Tiered store(分级存储模块)**
16+
17+
每个模块的具体作用可以参照[Rocketmq的官方说明文档](https://github.com/apache/rocketmq/tree/develop/docs) 。Rust的实现会根据下面的顺序逐一来进行实现。
18+
19+
## Name Server
20+
21+
### Broker管理
22+
23+
- [ ] [WIP]Broker注册
24+
- [ ] HeartBeat消息处理
25+
26+
TODO
27+
28+
后续会进行其他的模块实现,首先会对NameServer进行Rust实现,目标是能够达到和Java版本一样的功能。

README.md

+28-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,28 @@
1-
# rocketmq-rust
1+
# rocketmq-rust
2+
3+
Unofficial Rust implementation of RocketMQ.
4+
5+
## Modules
6+
7+
The existing RocketMQ has the following functional modules:
8+
9+
- **Name Server**
10+
- **Broker**
11+
- **Store (Local Storage)**
12+
- **Controller (High Availability)**
13+
- **Client (SDK)**
14+
- **Proxy**
15+
- **Tiered Store (Tiered Storage Module)**
16+
17+
The specific functions of each module can be referred to in the [official RocketMQ documentation](https://github.com/apache/rocketmq/tree/develop/docs). The Rust implementation will be carried out sequentially in the following order.
18+
19+
## Name Server
20+
21+
### Broker Management
22+
23+
- [ ] **[WIP] Broker registration**
24+
- [ ] **Heartbeat message processing**
25+
26+
TODO
27+
28+
Other module implementations will be done subsequently, starting with the Rust implementation of the Name Server. The goal is to achieve functionality similar to the Java version.

0 commit comments

Comments
 (0)