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

Commit 7aa0781

Browse files
committed
Update docs
1 parent c8f9f71 commit 7aa0781

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

docs/4.6/CommunicationMethods.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ X-Client-Role: Event
6363

6464
其中,`X-Client-Role` 可能为 `Event``API`,分别对应事件上报和 API 的两个连接。`X-Client-Role` 头的存在意味着你可以将 `ws_reverse_api_url``ws_reverse_event_url` 设置为相同的地址,或简单地使用 `ws_reverse_url` 来配置共用地址即可,然后只需要在 WebSocket 后端对请求头进行判断即可知道是哪个账号的哪个客户端在连接。
6565

66-
除了使用 API 和 Event 双连接的方式,还可以通过将配置项 `ws_reverse_use_universal_client` 设为 `true`(默认 `false`)来让插件**只向 `ws_reverse_url` 建立一条连接**`X-Client-Role``Universal`,API 和 Event 的数据均从这条连接上传输(相当于 API 和 Event 客户端的合并,对接收到的数据可通过 `post_type` 字段来判断是 API 响应还是事件)。统一客户端单连接的使用方式和分开的 API 和 Event 完全一致,下面不在单独说明。
66+
除了使用 API 和 Event 双连接的方式,还可以通过将配置项 `ws_reverse_use_universal_client` 设为 `true`(默认 `false`)来让插件**只向 `ws_reverse_url` 建立一条连接**`X-Client-Role``Universal`,API 和 Event 的数据均从这条连接上传输(相当于 API 和 Event 客户端的合并,对接收到的数据可通过 `post_type` 字段来判断是 API 响应还是事件)。Universal 客户端单连接的使用方式和分开的 API 和 Event 完全一致,下面不在单独说明。
6767

6868
如果配置了 `access_token`,则在建立连接时,还会加入 `Authorization` 请求头,例如:
6969

docs/4.6/Configuration.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,10 @@ port = 5701
9393
| `ws_reverse_event_url` || 反向 WebSocket 事件上报地址,如果为空,则使用 `ws_reverse_url` 指定的值 |
9494
| `ws_reverse_reconnect_interval` | `3000` | 反向 WebSocket 客户端断线重连间隔,单位毫秒 |
9595
| `ws_reverse_reconnect_on_code_1000` | `true` | 是否在关闭状态码为 1000 的时候重连 |
96+
| `ws_reverse_use_universal_client` | `false` | 是否使用 Universal 客户端 |
9697
| `use_ws_reverse` | `false` | 是否使用反向 WebSocket 服务,即插件作为 WebSocket 客户端主动连接指定的 API 和事件上报地址,见 [通信方式的第三种](/CommunicationMethods#插件作为-websocket-客户端(反向-websocket)) |
9798
| `post_url` || 消息和事件的上报地址,通过 POST 方式请求,数据以 JSON 格式发送 |
98-
| `post_timeout` | `0` | HTTP 上报(即访问 `post_url`)的超时时间(单位:秒),0 表示不设置超时 |
99+
| `post_timeout` | `0` | HTTP 上报(即访问 `post_url`)的超时时间,单位秒,0 表示不设置超时 |
99100
| `access_token` || API 访问 token,如果不为空,则会在接收到请求时验证 `Authorization` 请求头是否为 `Token xxxxxxxx``xxxxxxxx` 为 access token |
100101
| `secret` || 上报数据签名密钥,如果不为空,则会在 HTTP 上报时对 HTTP 正文进行 HMAC SHA1 哈希,使用 `secret` 的值作为密钥,计算出的哈希值放在上报的 `X-Signature` 请求头,例如 `X-Signature: sha1=f9ddd4863ace61e64f462d41ca311e3d2c1176e2` |
101102
| `post_message_format` | `string` | 上报消息格式,`string` 为字符串格式,`array` 为数组格式,具体见 [消息格式](/Message) |
@@ -110,11 +111,13 @@ port = 5701
110111
| `event_filter` || 指定事件过滤规则文件,见 [事件过滤器](/EventFilter),留空将不开启事件过滤器 |
111112
| `enable_backward_compatibility` | `false` | 是否启用旧版兼容性,启用时**事件上报**的数据将和 3.x 版本保持兼容 |
112113
| `show_log_console` | `false` | 是否显示日志输出控制台 |
113-
| `max_log_file_size` | `6291456` | 最大单日志文件大小,默认 6 MB |
114+
| `max_log_file_size` | `6291456` | 最大单日志文件大小,单位字节,默认 6 MB |
114115
| `max_log_files` | `1` | 最大日志文件备份数量(采用日志轮替机制) |
115116
| `log_level` | `info` | 日志文件和日志控制台的日志等级,可选 `debug``info``warning``error``fatal` |
116117
| `use_extension` | `false` | 是否启用扩展机制,见 [扩展](/Extension) |
117-
| `disable_coolq_log` | `true` | 是否禁用酷 Q 原生日志,由于使用酷 Q 原生日志可能会导致快速重启时插件卡死,所以默认禁用,如果你不在乎重启时卡死,并且需要在酷 Q 原生日志窗口查看插件的日志,可以将此项设为 false |
118+
| `disable_coolq_log` | `true` | 是否禁用酷 Q 原生日志,由于使用酷 Q 原生日志可能会导致快速重启时插件卡死,所以默认禁用,如果你不在乎重启时卡死,并且需要在酷 Q 原生日志窗口查看插件的日志,可以将此项设为 `false` |
118119
| `online_status_detection_method` | `log_db` | QQ 在线状态检测方式,默认(`log_db`)从酷 Q 的日志数据库判断,设为 `get_stranger_info` 可切换成通过查询陌生人接口判断(频繁请求可能导致结果不准) |
119120
| `enable_heartbeat` | `false` | 是否启用心跳机制,启用时会产生类型为 `heartbeat` 的元事件,见 [元事件](/Post#元事件) |
120-
| `heartbeat_interval` | `15000` | 产生心跳元事件的时间间隔,默认 15 秒 |
121+
| `heartbeat_interval` | `15000` | 产生心跳元事件的时间间隔,单位毫秒 |
122+
| `enable_rate_limited_actions` | `false` | 是否启用限速 API 调用的支持 |
123+
| `rate_limit_interval` | `500` | 限速 API 调用的排队间隔时间,单位毫秒 |

0 commit comments

Comments
 (0)