You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.
# WebSocket
使用标准的 WebSocket 来传输数据。
WebSocket 连接可以被其它 HTTP 服务器（如 Nginx） ，
::: tip
Websocket 会识别 HTTP 请求的 X-Forwarded-For 头来覆写流量的源地址，优先级高于 PROXY protocol。
:::
## WebSocketObject
`WebSocketObject` 对应传输配置的 `wsSettings` 项。
```json
{
"acceptProxyProtocol" : false ,
"path" : "/" ,
"headers" : {
"Host" : "xray.com"
}
}
```
> `acceptProxyProtocol`: true | false
仅用于 inbound，
[PROXY protocol ](https://www.haproxy.org/download/2.2/doc/proxy-protocol.txt ) 专用于传递请求的真实来源 IP 和端口，**若你不了解它，请先忽略该项**。
常见的反代软件（如 HAProxy、Nginx） ，
填写 `true` 时，最底层 TCP 连接建立后，请求方必须先发送 PROXY protocol v1 或 v2，
> `path` string
WebSocket 所使用的 HTTP 协议路径，默认值为 `"/"` 。
如果路径中包含 `ed` 参数，将会启用 `Early Data` 以降低延迟，其值为首包长度阈值。如果首包长度超过此值，就不会启用 `Early Data` 。建议的值为 2048。
::: warning
`Early Data` 使用 `Sec-WebSocket-Protocol` 头承载数据。如果你遇到兼容性问题，可以尝试调低阈值。
:::
> `headers`: map \{string: string\}
自定义 HTTP 头，一个键值对，每个键表示一个 HTTP 头的名称，对应的值是字符串。
默认值为空。
