TsgcWebSocketClient › 属性

TsgcWebSocketClient 属性

按用途分组的已发布属性，以及完整的字母排序列表。

连接

名称	描述
Active	打开或关闭到已配置服务器的 WebSocket 连接。
Host	客户端将连接到的 WebSocket 服务器的 IP 地址或 DNS 名称。
Port	用于连接到 WebSocket 服务器的 TCP 端口。
URL	只写快捷方式，通过单个 WebSocket URL 填充 Host、Port、TLS 和参数。
TLS	启用到 WebSocket 服务器的安全 TLS/SSL 连接。
IPVersion	选择 TCP 连接使用的 IP 协议版本（IPv4 或 IPv6）。

超时设置

名称	描述
ConnectTimeout	客户端等待 TCP 连接建立的最长时间（毫秒）。
ReadTimeout	客户端在引发读取超时之前等待传入数据的最长时间（毫秒）。
WriteTimeout	向对端发送数据的最大持续时间（毫秒）。

可靠性

名称	描述
HeartBeat	定期发送 WebSocket ping 帧以保持连接活跃。
WatchDog	在意外断开连接后自动重新连接到服务器。

安全性

名称	描述
Proxy	通过 HTTP 或 SOCKS 代理服务器路由 WebSocket 连接。
Authentication	配置用于验证 WebSocket 握手的凭据和方案。
TLSOptions	配置 TLS 启用时使用的证书、TLS 版本、ALPN、IOHandler 及其他安全连接详情。

消息传递

名称	描述
QueueOptions	将出站 Text、Binary 和 Ping 消息排队，以便在连接线程上串行发送。

诊断

名称	描述
NotifyEvents	控制 WebSocket 事件如何分派到主线程。
LogFile	将入站和出站套接字流量持久化到文件，用于调试线路协议。
Version	只读字符串，返回当前 sgcWebSockets 库版本。

高级

名称	描述
Extensions	启用 WebSocket 协议扩展，例如逐消息 deflate 压缩。
选项	自定义握手头，并微调客户端行为，如分片和 UTF-8 验证。
Specifications	选择客户端允许协商的 WebSocket 线路规范。
限流	限制客户端套接字每秒发送或接收的比特数。

其他

名称	描述
LoadBalancer	连接到 sgcWebSockets 负载均衡器服务器或手动定义的 WebSocket 服务器池。

所有属性（按字母排序）

名称	描述
Active	打开或关闭到已配置服务器的 WebSocket 连接。
Authentication	配置用于验证 WebSocket 握手的凭据和方案。
ConnectTimeout	客户端等待 TCP 连接建立的最长时间（毫秒）。
Extensions	启用 WebSocket 协议扩展，例如逐消息 deflate 压缩。
HeartBeat	定期发送 WebSocket ping 帧以保持连接活跃。
Host	客户端将连接到的 WebSocket 服务器的 IP 地址或 DNS 名称。
IPVersion	选择 TCP 连接使用的 IP 协议版本（IPv4 或 IPv6）。
LoadBalancer	连接到 sgcWebSockets 负载均衡器服务器或手动定义的 WebSocket 服务器池。
LogFile	将入站和出站套接字流量持久化到文件，用于调试线路协议。
NotifyEvents	控制 WebSocket 事件如何分派到主线程。
选项	自定义握手头，并微调客户端行为，如分片和 UTF-8 验证。
Port	用于连接到 WebSocket 服务器的 TCP 端口。
Proxy	通过 HTTP 或 SOCKS 代理服务器路由 WebSocket 连接。
QueueOptions	将出站 Text、Binary 和 Ping 消息排队，以便在连接线程上串行发送。
ReadTimeout	客户端在引发读取超时之前等待传入数据的最长时间（毫秒）。
Specifications	选择客户端允许协商的 WebSocket 线路规范。
限流	限制客户端套接字每秒发送或接收的比特数。
TLS	启用到 WebSocket 服务器的安全 TLS/SSL 连接。
TLSOptions	配置 TLS 启用时使用的证书、TLS 版本、ALPN、IOHandler 及其他安全连接详情。
URL	只写快捷方式，通过单个 WebSocket URL 填充 Host、Port、TLS 和参数。
Version	只读字符串，返回当前 sgcWebSockets 库版本。
WatchDog	在意外断开连接后自动重新连接到服务器。
WriteTimeout	向对端发送数据的最大持续时间（毫秒）。