Skip to content
This repository has been archived by the owner on Aug 2, 2020. It is now read-only.

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
stdrc committed Nov 4, 2017
1 parent 7c6a2b8 commit 1e65c5d
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion docs/3.1/CommunicationMethods.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,20 @@ API 的调用方式和插件作为 WebSocket 服务端的 `/api/` 接口使用

#### 事件上报

从 3.1.1 版本开始行为和 3.1.0 不太一致,下面区别对待:

##### v3.1.1

插件启动时会启动一个**保持连接**的客户端用于连接事件上报接口,即 `ws_reverse_event_url` 指定的接口,在后续接收到酷 Q 的事件时,会通过这个连接发送事件数据。发送事件数据格式和 HTTP POST 方式上报的完全一致,见 [上报数据格式](/Post#上报数据格式),事件列表见 [事件列表](/Post#事件列表)

与 HTTP 上报不同的是,这里上报不会对数据进行签名(即 HTTP 上报中的 `X-Signature` 请求头在这里没有等价的东西),并且也不会处理响应数据。

**注:3.1.1 之后的版本这里是保持连接的,启动时建立连接,每次发送之后连接都不会变动。**

##### v3.1.0

插件在收到酷 Q 事件时,会向 `ws_reverse_event_url` 指定的接口建立连接,并发送事件数据,**然后关闭连接**。发送事件数据格式和 HTTP POST 方式上报的完全一致,见 [上报数据格式](/Post#上报数据格式),事件列表见 [事件列表](/Post#事件列表)

与 HTTP 上报不同的是,这里上报不会对数据进行签名(即 HTTP 上报中的 `X-Signature` 请求头在这里没有等价的东西),并且也不会处理响应数据。

**再次注意:API 调用需要服务端保持连接,而事件上报在上报完成后插件就会主动关闭连接,如果你的服务端没有正确处理,有可能造成服务不可用**
**注:3.1.0 版本这里是不保持连接的,每次事件上报会重新建立连接,上报之后关闭**

0 comments on commit 1e65c5d

Please sign in to comment.