From 8af7854d83ccf061bea88bb0e80ddac6e5a8b64d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=A7=8B=E9=9B=A8=E8=90=BD?= Date: Mon, 18 Sep 2023 17:09:36 +0800 Subject: [PATCH] :memo: Update docs. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 秋雨落 --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4772be7..7d782bf 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ ## 传输协议 -版本:**V1.0(2023.9.17)** +版本:**V1.0.1(2023.9.18 更新)** 水晶互联采用 WebSocket 进行消息传输,使用 CBOR 进行消息编码。 @@ -86,6 +86,10 @@ enum MessageDirection { } ``` +`Incoming` 代表服务端向客户端转发的信息,`Outgoing` 代表客户端向服务端发布的信息,`All` 代表双向通信。 + +注意:**在 WebSocket 传输过程中,枚举值使用对应的 Int 值进行传输。** + ##### ID 字符串(IdString) @@ -149,7 +153,7 @@ ChannelName 是自定义的频道名。 ``` > Register > -> +> ```