TsgcWebSocketServer_HTTPAPI › Properties

TsgcWebSocketServer_HTTPAPI Properties

Published properties grouped by purpose, followed by the full alphabetical list.

Connection

Name	Description
Active	Starts or stops the HTTP.sys listener, registering the configured URL with the Windows kernel driver.
Host	Hostname or IP address used to build the URL registered with the http.sys driver.
Port	TCP port that, combined with Host, forms the URL the http.sys driver reserves for the server.
BindingOptions	Fine-tunes how URL reservations and SSL certificates are registered with the http.sys driver at start-up.
MaxConnections	Maximum number of concurrent client connections accepted by the http.sys listener (zero means unlimited).

Timeouts

Name	Description
Timeouts	Overrides the default http.sys request, entity-body, keep-alive and send-rate timeouts.

Security

Name	Description
Authentication	Enables and configures user/password authentication for incoming WebSocket and HTTP requests.
SSL	Enables TLS/SSL on the http.sys listener so that clients can connect using wss:// or https://.
SSLOptions	Identifies the Windows Certificate Store entry that http.sys binds to the listener when SSL is enabled.
SecurityOptions	Defines admission rules such as allowed origins for browser WebSocket handshakes.
APIKeyManager	Optional API-key manager component used to validate incoming API keys before accepting a connection.

Reliability

Name	Description
HeartBeat	Sends periodic ping frames to keep idle WebSocket connections alive and detect dead peers.
WatchDog	Automatically restarts the server after an unexpected shutdown or listener failure.
Firewall	Assigns a firewall component that filters incoming connections by IP, region or custom rules.
RateLimiter	Assigns a rate-limiter component that caps request and message rates per client or per IP.

Performance

Name	Description
Asynchronous	Enables fire-and-forget sends: the caller returns immediately and completion is signalled through the OnAsynchronous event.
MaxBandwidth	Maximum allowed bandwidth in bytes per second across all connections (zero means unlimited).
ThreadPoolSize	Number of worker threads serving the http.sys request queue through IOCP.
ReadBufferSize	Size in bytes of the receive buffer allocated per pending overlapped read against the http.sys request queue.
FineTune	Low-level kernel-mode knobs that shape how http.sys queues, dispatches and completes requests.

HTTP

Name	Description
HTTPUploadFiles	Controls how files uploaded through HTTP POST are buffered (memory or file stream) and saved to disk.

Advanced

Name	Description
Options	Bundles miscellaneous server behaviour flags: fragment handling, write timeouts, HTTP test pages and UTF-8 validation.
QueueOptions	Serialises outbound messages through an internal per-connection queue to prevent contention between threads.
Extensions	Configures WebSocket protocol extensions such as per-message deflate compression.
Specifications	Enables or disables the WebSocket protocol specifications the server will accept.

Diagnostics

Name	Description
LogFile	Writes every incoming and outgoing socket message to a log file for debugging and auditing.
Version	Read-only string with the sgcWebSockets library version embedded in the binary.

All Properties (alphabetical)

Name	Description
Active	Starts or stops the HTTP.sys listener, registering the configured URL with the Windows kernel driver.
APIKeyManager	Optional API-key manager component used to validate incoming API keys before accepting a connection.
Asynchronous	Enables fire-and-forget sends: the caller returns immediately and completion is signalled through the OnAsynchronous event.
Authentication	Enables and configures user/password authentication for incoming WebSocket and HTTP requests.
BindingOptions	Fine-tunes how URL reservations and SSL certificates are registered with the http.sys driver at start-up.
Extensions	Configures WebSocket protocol extensions such as per-message deflate compression.
FineTune	Low-level kernel-mode knobs that shape how http.sys queues, dispatches and completes requests.
Firewall	Assigns a firewall component that filters incoming connections by IP, region or custom rules.
HeartBeat	Sends periodic ping frames to keep idle WebSocket connections alive and detect dead peers.
Host	Hostname or IP address used to build the URL registered with the http.sys driver.
HTTPUploadFiles	Controls how files uploaded through HTTP POST are buffered (memory or file stream) and saved to disk.
LogFile	Writes every incoming and outgoing socket message to a log file for debugging and auditing.
MaxBandwidth	Maximum allowed bandwidth in bytes per second across all connections (zero means unlimited).
MaxConnections	Maximum number of concurrent client connections accepted by the http.sys listener (zero means unlimited).
Options	Bundles miscellaneous server behaviour flags: fragment handling, write timeouts, HTTP test pages and UTF-8 validation.
Port	TCP port that, combined with Host, forms the URL the http.sys driver reserves for the server.
QueueOptions	Serialises outbound messages through an internal per-connection queue to prevent contention between threads.
RateLimiter	Assigns a rate-limiter component that caps request and message rates per client or per IP.
ReadBufferSize	Size in bytes of the receive buffer allocated per pending overlapped read against the http.sys request queue.
SecurityOptions	Defines admission rules such as allowed origins for browser WebSocket handshakes.
Specifications	Enables or disables the WebSocket protocol specifications the server will accept.
SSL	Enables TLS/SSL on the http.sys listener so that clients can connect using wss:// or https://.
SSLOptions	Identifies the Windows Certificate Store entry that http.sys binds to the listener when SSL is enabled.
ThreadPoolSize	Number of worker threads serving the http.sys request queue through IOCP.
Timeouts	Overrides the default http.sys request, entity-body, keep-alive and send-rate timeouts.
Version	Read-only string with the sgcWebSockets library version embedded in the binary.
WatchDog	Automatically restarts the server after an unexpected shutdown or listener failure.