Skip to content

Commit 2c8c2bd

Browse files
authored
doce: add 'slot' parameter and update 'mode' description in API documentation
1 parent 375f8a2 commit 2c8c2bd

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

docs/en/api.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1264,9 +1264,10 @@ Examples:
12641264
| `tls` | TLS encryption level | `0`(none), `1`(self-signed), `2`(certificate) | `0` | Server only |
12651265
| `crt` | Certificate path | File path | None | Server only |
12661266
| `key` | Private key path | File path | None | Server only |
1267-
| `mode` | Runtime mode control | `0`(auto), `1`(force mode 1), `2`(force mode 2) | `0` | Both |
12681267
| `min` | Minimum pool capacity | Integer > 0 | `64` | Client dual-end handshake mode only |
12691268
| `max` | Maximum pool capacity | Integer > 0 | `1024` | Dual-end handshake mode |
1269+
| `mode` | Runtime mode control | `0`(auto), `1`(force mode 1), `2`(force mode 2) | `0` | Both |
12701270
| `read` | Read timeout duration | Time duration (e.g., `10m`, `30s`, `1h`) | `10m` | Both |
12711271
| `rate` | Bandwidth rate limit | Integer (Mbps), 0=unlimited | `0` | Both |
1272+
| `slot` | Connection slot count | Integer (1-65536) | `65536` | Both |
12721273
| `proxy` | PROXY protocol support | `0`(disabled), `1`(enabled) | `0` | Both |

docs/zh/api.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1262,9 +1262,10 @@ client://<server_host>:<server_port>/<local_host>:<local_port>?<parameters>
12621262
| `tls` | TLS加密级别 | `0`(无), `1`(自签名), `2`(证书) | `0` | 仅服务器 |
12631263
| `crt` | 证书路径 | 文件路径 || 仅服务器 |
12641264
| `key` | 私钥路径 | 文件路径 || 仅服务器 |
1265-
| `mode` | 运行模式控制 | `0`(自动), `1`(强制模式1), `2`(强制模式2) | `0` | 两者 |
12661265
| `min` | 最小连接池容量 | 整数 > 0 | `64` | 仅客户端双端握手模式 |
12671266
| `max` | 最大连接池容量 | 整数 > 0 | `1024` | 双端握手模式 |
1267+
| `mode` | 运行模式控制 | `0`(自动), `1`(强制模式1), `2`(强制模式2) | `0` | 两者 |
12681268
| `read` | 读取超时时间 | 时间长度 (如 `10m`, `30s`, `1h`) | `10m` | 两者 |
12691269
| `rate` | 带宽速率限制 | 整数 (Mbps), 0=无限制 | `0` | 两者 |
1270+
| `slot` | 连接槽位数 | 整数 (1-65536) | `65536` | 两者 |
12701271
| `proxy` | PROXY协议支持 | `0`(禁用), `1`(启用) | `0` | 两者 |

0 commit comments

Comments
 (0)