修改协议

Author: zgwit

docs/protocol.md

@@ -4,44 +4,50 @@
 
 ## 一、包头
 
-### 固定头 4字节
+### 固定头 8字节
 
-| 标识   | 长度（位） | 说明    |
-|------|-------|-------|
-| 魔术字  | 24    | “rpc” |
-| 包含数据 | 1     | 0/1   |
-| 数据结束 | 1     | 0/1   |
-| 数据格式 | 2     | 0-3   |
-| 包类型  | 3     | 0-7   |
+| 标识     | 长度（位） | 说明         |
+|--------|-------|------------|
+| 魔术字    | 24    | “rpc”      |
+| 包类型    | 4     | 0-15       |
+| 数据格式   | 4     | 0-15       |
+| 事务/流ID | 16    | 0-65535，自增 |
+| 包体数据长度 | 16    | 0-64KB     |
 
-### 扩展头 4字节
-
-| 标识   | 长度（位） | 说明      |
-|------|-------|---------|
-| 序号   | 16    | 0-65535 |
-| 数据长度 | 16    | 0-64KB  |
 
 ### 包类型
 
-| 类型          | id | 扩展头 | 方向 | 说明   |
-|-------------|----|-----|----|------|
-| -           | 0  |     |    | 无效   |
-| CONNECT     | 1  | Y   | 上行 | 连接   |
-| CONNECT_ACK | 2  | Y   | 下行 | 连接响应 |
-| HEARTBEAT   | 3  |     | 上行 | 心跳   |
-| REQUEST     | 4  | Y   | 双向 | 请求   |
-| RESPONSE    | 5  | Y   | 双向 | 响应   |
-| STREAM      | 6  | Y   | 双向 | 数据流  |
-| DISCONNECT  | 7  | Y/N | 双向 | 关闭连接 |
+| id | 类型            | 方向 | 说明    |
+|----|---------------|----|-------|
+| 0  | DISCONNECT    | 双向 | 关闭连接  |
+| 1  | CONNECT       | 上行 | 连接    |
+| 2  | CONNECT_ACK   | 下行 | 连接响应  |
+| 3  | HEARTBEAT     | 上行 | 心跳    |
+| 4  | REQUEST       | 双向 | 请求    |
+| 5  | REQUEST_END   | 双向 | 请求结束  |
+| 6  | RESPONSE      | 双向 | 响应    |
+| 7  | RESPONSE_END  | 双向 | 响应结束  |
+| 8  | STREAM        | 双向 | 数据流   |
+| 9  | STREAM_END    | 双向 | 数据流结束 |
+| 10 | PUBLISH       | 双向 | 发布    |
+| 11 | PUBLISH_END   | 双向 | 发布结束  |
+| 12 | PUBLISH_ACK   | 双向 | 发布响应  |
+| 13 | SUBSCRIBE     | 上行 | 订阅    |
+| 14 | SUBSCRIBE_ACK | 下行 | 订阅响应  |
+| 15 | UNSUBSCRIBE   | 上行 | 取消订阅  |
 
 ### 数据格式
 
-| 类型          | id | 说明         |
-|-------------|----|------------|
-| Binary      | 0  | 默认二进制      |
-| JSON        | 1  |            |
-| YAML        | 2  |            |
-| MessagePack | 3  |            |
+| id   | 类型       | 说明         |
+|------|----------|------------|
+| 0    | binary   | 默认二进制      |
+| 1    | json     | 通用性强       |
+| 2    | xml      |            |
+| 3    | yaml     | 较JSON省流，清晰 |
+| 4    | csv      |            |
+| 5    | msgpack  | 省流，高性能     |
+| 6    | protobuf |            |
+| 7-15 | custom   | 自定义        |
 
 数据格式建议使用默认的json格式，方便开发和调试，对于需要省流的场景，可以改进为msgpack或二进制
 
@@ -68,7 +74,7 @@
 }
 ```
 
-### CONNACK 连接响应
+### CONNECT_ACK 连接响应
 
 ```json5
 {
@@ -87,6 +93,8 @@
 
 流ID，客户端发起用奇数，服务端发起用偶数
 
+### STREAM_END 数据流结束
+内容为二进制
 
 ### REQUEST 请求
 
@@ -124,3 +132,4 @@
 - [设备](protocol_device.md)
 - [OTA升级](protocol_ota.md)
 - [文件系统](protocol_fs.md)
+- [摄像头](protocol_camera.md)