TsgcWebSocketServer Properties

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

Connection

Name	Description
Active	Starts or stops the server, opening the listening sockets on the configured bindings.
Port	TCP port on which the server accepts incoming WebSocket and HTTP connections.
Bindings	Collection of IP/Port pairs the server listens on; use it to bind several endpoints simultaneously.
MaxConnections	Maximum number of concurrent client connections accepted by the server.

Security

Name	Description
Authentication	Enables and configures user/password authentication for incoming WebSocket and HTTP connections.
SSL	Enables TLS/SSL on the server so that clients can connect using wss:// or https://.
SSLOptions	Holds certificate paths, TLS version selection and OpenSSL tuning for the TLS listener.
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 client connections alive and detect dead peers.
WatchDog	Automatically restarts the server after an unexpected shutdown or listener failure.
LoadBalancer	Configures the built-in client used to register this server with a Load Balancer Server instance.
FallBack	Provides alternative transports for browsers that do not support native WebSockets.
RateLimiter	Assigns a rate-limiter component that caps request and message rates per client or per IP.
Firewall	Assigns a firewall component that filters incoming connections by IP, region or custom rules.

Advanced

Name	Description
Options	Bundles miscellaneous server behaviour flags: fragment handling, 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.
HTTP2Options	Enables and tunes the HTTP/2 protocol handler used to serve HTTPS requests.
IOHandlerOptions	Selects the I/O strategy used to service connections: thread-per-connection, IOCP or EPOLL.
ThreadPool	Enables a thread pool that recycles worker threads instead of destroying them when connections close.
ThreadPoolOptions	Configures the size and upper bound of the reusable thread pool.
Throttle	Caps the bandwidth (bits per second) that the server reads from or writes to each connection.

Diagnostics

Name	Description
LogFile	Writes every incoming and outgoing socket message to a log file for debugging and auditing.
NotifyEvents	Controls how threaded WebSocket events are synchronized with the main VCL thread.
Version	Read-only string with the sgcWebSockets library version embedded in the binary.

All Properties (alphabetical)

Name	Description
Active	Starts or stops the server, opening the listening sockets on the configured bindings.
APIKeyManager	Optional API-key manager component used to validate incoming API keys before accepting a connection.
Authentication	Enables and configures user/password authentication for incoming WebSocket and HTTP connections.
Bindings	Collection of IP/Port pairs the server listens on; use it to bind several endpoints simultaneously.
Extensions	Configures WebSocket protocol extensions such as per-message deflate compression.
FallBack	Provides alternative transports for browsers that do not support native WebSockets.
Firewall	Assigns a firewall component that filters incoming connections by IP, region or custom rules.
HeartBeat	Sends periodic ping frames to keep idle client connections alive and detect dead peers.
HTTP2Options	Enables and tunes the HTTP/2 protocol handler used to serve HTTPS requests.
IOHandlerOptions	Selects the I/O strategy used to service connections: thread-per-connection, IOCP or EPOLL.
LoadBalancer	Configures the built-in client used to register this server with a Load Balancer Server instance.
LogFile	Writes every incoming and outgoing socket message to a log file for debugging and auditing.
MaxConnections	Maximum number of concurrent client connections accepted by the server.
NotifyEvents	Controls how threaded WebSocket events are synchronized with the main VCL thread.
Options	Bundles miscellaneous server behaviour flags: fragment handling, timeouts, HTTP test pages and UTF-8 validation.
Port	TCP port on which the server accepts incoming WebSocket and HTTP connections.
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.
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 server so that clients can connect using wss:// or https://.
SSLOptions	Holds certificate paths, TLS version selection and OpenSSL tuning for the TLS listener.
ThreadPool	Enables a thread pool that recycles worker threads instead of destroying them when connections close.
ThreadPoolOptions	Configures the size and upper bound of the reusable thread pool.
Throttle	Caps the bandwidth (bits per second) that the server reads from or writes to each connection.
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.