TsgcWebSocketHTTPServer › 属性

TsgcWebSocketHTTPServer 属性

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

连接

名称描述
Active启动或停止 HTTP/WebSocket 服务器,在配置的绑定上打开侦听套接字。
Port服务器接受传入 HTTP 和 WebSocket 连接的 TCP 端口。
Bindings服务器监听的 IP/端口对集合;使用它可同时绑定多个端点。
MaxConnections服务器可接受的最大并发客户端连接数。
KeepAlive在发送响应后保持 HTTP 连接打开,以便后续请求可以复用该连接。

HTTP

名称描述
DocumentRoot内置 HTTP 服务器用于提供静态文件(HTML、JavaScript、CSS、图像等)的目录。
HTTP2Options启用并调整用于服务 HTTPS 请求的 HTTP/2 协议处理程序。
HTTPUploadFiles控制通过 HTTP POST 上传的文件如何缓冲(内存或文件流)并保存到磁盘。

会话

名称描述
AutoStartSession当启用会话状态时,为每个传入请求自动创建新的 HTTP 会话。
SessionState在无状态 HTTP 协议之上启用基于 Cookie 的 HTTP 会话跟踪。
SessionTimeOutHTTP 会话被视为过期并可被移除的空闲超时时间(毫秒)。

安全性

名称描述
Authentication启用并配置对传入 WebSocket 和 HTTP 连接的用户名/密码认证。
SSL在服务器上启用 TLS/SSL,使客户端可以使用 wss:// 或 https:// 进行连接。
SSLOptions保存 TLS 监听器的证书路径、TLS 版本选择和 OpenSSL 调整选项。
SecurityOptions定义准入规则,例如允许浏览器 WebSocket 握手的来源。
APIKeyManager可选的 API 密钥管理器组件,用于在接受连接前验证传入的 API 密钥。

可靠性

名称描述
HeartBeat定期发送 ping 帧,以保持空闲客户端连接活跃并检测失效对端。
WatchDog在意外关闭或监听器故障后自动重启服务器。
LoadBalancer配置用于将此服务器注册到负载均衡器服务器实例的内置客户端。
FallBack为不支持原生 WebSocket 的浏览器提供替代传输方式。
RateLimiter分配一个速率限制组件,按客户端或 IP 限制请求和消息速率。
防火墙分配一个防火墙组件,按 IP、地区或自定义规则过滤传入连接。

高级

名称描述
选项捆绑各种服务器行为标志:分片处理、超时、HTTP 测试页面和 UTF-8 验证。
QueueOptions通过内部每连接队列序列化出站消息,以防止线程间的竞争。
Extensions配置 WebSocket 协议扩展,例如逐消息 deflate 压缩。
Specifications启用或禁用服务器将接受的 WebSocket 协议规范。
IOHandlerOptions选择用于服务连接的 I/O 策略:每连接一线程、IOCP 或 EPOLL。
ThreadPool启用线程池,在连接关闭时回收工作线程而不是销毁它们。
ThreadPoolOptions配置启用 ThreadPool 时使用的可重用线程池的大小和上限。
限流限制服务器对每个连接读取或写入的带宽(位/秒)。

诊断

名称描述
LogFile将每条传入和传出的套接字消息写入日志文件,用于调试和审计。
NotifyEvents控制线程化的 WebSocket 事件如何与主 VCL 线程同步。
Version嵌入在二进制文件中的 sgcWebSockets 库版本的只读字符串。

所有属性(按字母排序)

名称描述
Active启动或停止 HTTP/WebSocket 服务器,在配置的绑定上打开侦听套接字。
APIKeyManager可选的 API 密钥管理器组件,用于在接受连接前验证传入的 API 密钥。
Authentication启用并配置对传入 WebSocket 和 HTTP 连接的用户名/密码认证。
AutoStartSession当启用会话状态时,为每个传入请求自动创建新的 HTTP 会话。
Bindings服务器监听的 IP/端口对集合;使用它可同时绑定多个端点。
DocumentRoot内置 HTTP 服务器用于提供静态文件(HTML、JavaScript、CSS、图像等)的目录。
Extensions配置 WebSocket 协议扩展,例如逐消息 deflate 压缩。
FallBack为不支持原生 WebSocket 的浏览器提供替代传输方式。
防火墙分配一个防火墙组件,按 IP、地区或自定义规则过滤传入连接。
HeartBeat定期发送 ping 帧,以保持空闲客户端连接活跃并检测失效对端。
HTTP2Options启用并调整用于服务 HTTPS 请求的 HTTP/2 协议处理程序。
HTTPUploadFiles控制通过 HTTP POST 上传的文件如何缓冲(内存或文件流)并保存到磁盘。
IOHandlerOptions选择用于服务连接的 I/O 策略:每连接一线程、IOCP 或 EPOLL。
KeepAlive在发送响应后保持 HTTP 连接打开,以便后续请求可以复用该连接。
LoadBalancer配置用于将此服务器注册到负载均衡器服务器实例的内置客户端。
LogFile将每条传入和传出的套接字消息写入日志文件,用于调试和审计。
MaxConnections服务器可接受的最大并发客户端连接数。
NotifyEvents控制线程化的 WebSocket 事件如何与主 VCL 线程同步。
选项捆绑各种服务器行为标志:分片处理、超时、HTTP 测试页面和 UTF-8 验证。
Port服务器接受传入 HTTP 和 WebSocket 连接的 TCP 端口。
QueueOptions通过内部每连接队列序列化出站消息,以防止线程间的竞争。
RateLimiter分配一个速率限制组件,按客户端或 IP 限制请求和消息速率。
SecurityOptions定义准入规则,例如允许浏览器 WebSocket 握手的来源。
SessionState在无状态 HTTP 协议之上启用基于 Cookie 的 HTTP 会话跟踪。
SessionTimeOutHTTP 会话被视为过期并可被移除的空闲超时时间(毫秒)。
Specifications启用或禁用服务器将接受的 WebSocket 协议规范。
SSL在服务器上启用 TLS/SSL,使客户端可以使用 wss:// 或 https:// 进行连接。
SSLOptions保存 TLS 监听器的证书路径、TLS 版本选择和 OpenSSL 调整选项。
ThreadPool启用线程池,在连接关闭时回收工作线程而不是销毁它们。
ThreadPoolOptions配置启用 ThreadPool 时使用的可重用线程池的大小和上限。
限流限制服务器对每个连接读取或写入的带宽(位/秒)。
Version嵌入在二进制文件中的 sgcWebSockets 库版本的只读字符串。
WatchDog在意外关闭或监听器故障后自动重启服务器。