TsgcWebSocketServer_HTTPAPI › 属性

TsgcWebSocketServer_HTTPAPI 属性

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

连接

名称描述
Active启动或停止 HTTP.sys 侦听器,将配置的 URL 注册到 Windows 内核驱动程序。
Host用于构建向 http.sys 驱动程序注册的 URL 的主机名或 IP 地址。
PortHost 结合构成 http.sys 驱动程序为服务器保留的 URL 的 TCP 端口。
BindingOptions精细控制 URL 保留项和 SSL 证书在启动时向 http.sys 驱动程序注册的方式。
MaxConnectionshttp.sys 监听器接受的最大并发客户端连接数(零表示无限制)。

超时设置

名称描述
Timeouts覆盖默认的 http.sys 请求、实体主体、保持连接和发送速率超时设置。

安全性

名称描述
Authentication为传入的 WebSocket 和 HTTP 请求启用并配置用户名/密码认证。
SSL在 http.sys 监听器上启用 TLS/SSL,使客户端能够使用 wss://https:// 进行连接。
SSLOptions标识当启用 SSL 时 http.sys 绑定到监听器的 Windows 证书存储条目。
SecurityOptions定义准入规则,例如允许浏览器 WebSocket 握手的来源。
APIKeyManager可选的 API 密钥管理器组件,用于在接受连接前验证传入的 API 密钥。

可靠性

名称描述
HeartBeat定期发送 ping 帧,以保持空闲的 WebSocket 连接活跃并检测断开的对端。
WatchDog在意外关闭或监听器故障后自动重启服务器。
防火墙分配一个防火墙组件,按 IP、地区或自定义规则过滤传入连接。
RateLimiter分配一个速率限制组件,按客户端或 IP 限制请求和消息速率。

性能

名称描述
Asynchronous启用即发即弃发送:调用方立即返回,完成情况通过 OnAsynchronous 事件通知。
MaxBandwidth所有连接的最大允许带宽(字节/秒)(零表示无限制)。
ThreadPoolSize通过 IOCP 处理 http.sys 请求队列的工作线程数。
ReadBufferSize为 http.sys 请求队列中每个待处理的重叠读取分配的接收缓冲区大小(字节)。
FineTune影响 http.sys 如何对请求进行排队、分发和完成的底层内核模式调节项。

HTTP

名称描述
HTTPUploadFiles控制通过 HTTP POST 上传的文件如何缓冲(内存或文件流)并保存到磁盘。

高级

名称描述
选项捆绑各类服务器行为标志:片段处理、写入超时、HTTP 测试页面和 UTF-8 验证。
QueueOptions通过内部每连接队列序列化出站消息,以防止线程间的竞争。
Extensions配置 WebSocket 协议扩展,例如逐消息 deflate 压缩。
Specifications启用或禁用服务器将接受的 WebSocket 协议规范。

诊断

名称描述
LogFile将每条传入和传出的套接字消息写入日志文件,用于调试和审计。
Version嵌入在二进制文件中的 sgcWebSockets 库版本的只读字符串。

所有属性(按字母排序)

名称描述
Active启动或停止 HTTP.sys 侦听器,将配置的 URL 注册到 Windows 内核驱动程序。
APIKeyManager可选的 API 密钥管理器组件,用于在接受连接前验证传入的 API 密钥。
Asynchronous启用即发即弃发送:调用方立即返回,完成情况通过 OnAsynchronous 事件通知。
Authentication为传入的 WebSocket 和 HTTP 请求启用并配置用户名/密码认证。
BindingOptions精细控制 URL 保留项和 SSL 证书在启动时向 http.sys 驱动程序注册的方式。
Extensions配置 WebSocket 协议扩展,例如逐消息 deflate 压缩。
FineTune影响 http.sys 如何对请求进行排队、分发和完成的底层内核模式调节项。
防火墙分配一个防火墙组件,按 IP、地区或自定义规则过滤传入连接。
HeartBeat定期发送 ping 帧,以保持空闲的 WebSocket 连接活跃并检测断开的对端。
Host用于构建向 http.sys 驱动程序注册的 URL 的主机名或 IP 地址。
HTTPUploadFiles控制通过 HTTP POST 上传的文件如何缓冲(内存或文件流)并保存到磁盘。
LogFile将每条传入和传出的套接字消息写入日志文件,用于调试和审计。
MaxBandwidth所有连接的最大允许带宽(字节/秒)(零表示无限制)。
MaxConnectionshttp.sys 监听器接受的最大并发客户端连接数(零表示无限制)。
选项捆绑各类服务器行为标志:片段处理、写入超时、HTTP 测试页面和 UTF-8 验证。
PortHost 结合构成 http.sys 驱动程序为服务器保留的 URL 的 TCP 端口。
QueueOptions通过内部每连接队列序列化出站消息,以防止线程间的竞争。
RateLimiter分配一个速率限制组件,按客户端或 IP 限制请求和消息速率。
ReadBufferSize为 http.sys 请求队列中每个待处理的重叠读取分配的接收缓冲区大小(字节)。
SecurityOptions定义准入规则,例如允许浏览器 WebSocket 握手的来源。
Specifications启用或禁用服务器将接受的 WebSocket 协议规范。
SSL在 http.sys 监听器上启用 TLS/SSL,使客户端能够使用 wss://https:// 进行连接。
SSLOptions标识当启用 SSL 时 http.sys 绑定到监听器的 Windows 证书存储条目。
ThreadPoolSize通过 IOCP 处理 http.sys 请求队列的工作线程数。
Timeouts覆盖默认的 http.sys 请求、实体主体、保持连接和发送速率超时设置。
Version嵌入在二进制文件中的 sgcWebSockets 库版本的只读字符串。
WatchDog在意外关闭或监听器故障后自动重启服务器。