TsgcWebSocketLoadBalancerServer › Properties

TsgcWebSocketLoadBalancerServer Properties

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

Connection

Name	Description
Active	Starts or stops the load balancer, opening the listening sockets that accept downstream clients and backend TsgcWebSocketServer registrations.
Port	TCP port on which the load balancer accepts incoming WebSocket/HTTP clients and backend server registrations.
Bindings	Collection of IP/Port pairs the load balancer listens on for downstream clients and backend registrations.
MaxConnections	Maximum number of concurrent TCP connections (downstream clients plus registered backends) accepted by the load balancer.

HTTP

Name	Description
HTTP2Options	Enables and tunes HTTP/2 on the load balancer's TLS listener used to serve HTTPS requests from downstream clients.

Security

Name	Description
SSL	Enables TLS/SSL on the load balancer so that clients can connect using wss:// or https://.
SSLOptions	Holds certificate paths, TLS version selection and OpenSSL tuning for the load balancer's TLS listener.
SecurityOptions	Defines admission rules such as allowed origins for WebSocket handshakes that reach the load balancer.

Reliability

Name	Description
LoadBalancer	Configures how the load balancer distributes downstream connections across registered backends and which protocols are balanced.
FallBack	Provides alternative transports on the load balancer for browsers that do not support native WebSockets.

Advanced

Name	Description
Options	Miscellaneous behaviour flags for the load balancer: fragment handling, timeouts, HTTP test pages and UTF-8 validation.
Extensions	Configures WebSocket protocol extensions such as per-message deflate compression on the load balancer front-end.
Specifications	Enables or disables the WebSocket protocol specifications the load balancer will accept from downstream clients.
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 used when ThreadPool is enabled.
Throttle	Caps the bandwidth (bits per second) that the load balancer reads from or writes to each connection.

Diagnostics

Name	Description
LogFile	Writes every socket message handled by the load balancer 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 load balancer, opening the listening sockets that accept downstream clients and backend TsgcWebSocketServer registrations.
Bindings	Collection of IP/Port pairs the load balancer listens on for downstream clients and backend registrations.
Extensions	Configures WebSocket protocol extensions such as per-message deflate compression on the load balancer front-end.
FallBack	Provides alternative transports on the load balancer for browsers that do not support native WebSockets.
HTTP2Options	Enables and tunes HTTP/2 on the load balancer's TLS listener used to serve HTTPS requests from downstream clients.
LoadBalancer	Configures how the load balancer distributes downstream connections across registered backends and which protocols are balanced.
LogFile	Writes every socket message handled by the load balancer to a log file for debugging and auditing.
MaxConnections	Maximum number of concurrent TCP connections (downstream clients plus registered backends) accepted by the load balancer.
Options	Miscellaneous behaviour flags for the load balancer: fragment handling, timeouts, HTTP test pages and UTF-8 validation.
Port	TCP port on which the load balancer accepts incoming WebSocket/HTTP clients and backend server registrations.
SecurityOptions	Defines admission rules such as allowed origins for WebSocket handshakes that reach the load balancer.
Specifications	Enables or disables the WebSocket protocol specifications the load balancer will accept from downstream clients.
SSL	Enables TLS/SSL on the load balancer so that clients can connect using wss:// or https://.
SSLOptions	Holds certificate paths, TLS version selection and OpenSSL tuning for the load balancer's 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 used when ThreadPool is enabled.
Throttle	Caps the bandwidth (bits per second) that the load balancer reads from or writes to each connection.
Version	Read-only string with the sgcWebSockets library version embedded in the binary.