TsgcWebSocketProxyServer › Properties

TsgcWebSocketProxyServer Properties

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

Connection

Name	Description
Active	Starts or stops the proxy, opening the listening sockets that accept downstream WebSocket clients.
Port	TCP port on which the proxy accepts incoming downstream WebSocket connections.
Bindings	Collection of IP/Port pairs the proxy listens on for incoming downstream WebSocket clients.
MaxConnections	Maximum number of concurrent downstream client connections accepted by the proxy.
Proxy	Identifies the upstream target — the real WebSocket/TCP server to which every accepted client is transparently forwarded.

Security

Name	Description
Authentication	Enables and configures user/password authentication for incoming WebSocket clients connecting to the proxy.
SSL	Enables TLS/SSL on the downstream listener so that clients can connect to the proxy using wss:// or https://.
SSLOptions	Holds certificate paths, TLS version selection and OpenSSL tuning for the downstream TLS listener.
SecurityOptions	Defines admission rules such as allowed origins for browser WebSocket handshakes reaching the proxy.

Reliability

Name	Description
LoadBalancer	Configures the built-in client used to register this proxy with a Load Balancer Server instance.
FallBack	Provides alternative transports (Flash, Server-Sent Events) for browsers that do not support native WebSockets.

Advanced

Name	Description
Options	Bundles miscellaneous proxy behaviour flags: fragment handling, timeouts, HTTP test pages and UTF-8 validation.
Extensions	Configures WebSocket protocol extensions such as per-message deflate compression for the downstream leg.
Specifications	Enables or disables the WebSocket protocol specifications the proxy will accept from downstream clients.
ThreadPool	Enables a thread pool that recycles worker threads instead of destroying them when proxied 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 proxy reads from or writes to each downstream connection.

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 proxy, opening the listening sockets that accept downstream WebSocket clients.
Authentication	Enables and configures user/password authentication for incoming WebSocket clients connecting to the proxy.
Bindings	Collection of IP/Port pairs the proxy listens on for incoming downstream WebSocket clients.
Extensions	Configures WebSocket protocol extensions such as per-message deflate compression for the downstream leg.
FallBack	Provides alternative transports (Flash, Server-Sent Events) for browsers that do not support native WebSockets.
LoadBalancer	Configures the built-in client used to register this proxy 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 downstream client connections accepted by the proxy.
Options	Bundles miscellaneous proxy behaviour flags: fragment handling, timeouts, HTTP test pages and UTF-8 validation.
Port	TCP port on which the proxy accepts incoming downstream WebSocket connections.
Proxy	Identifies the upstream target — the real WebSocket/TCP server to which every accepted client is transparently forwarded.
SecurityOptions	Defines admission rules such as allowed origins for browser WebSocket handshakes reaching the proxy.
Specifications	Enables or disables the WebSocket protocol specifications the proxy will accept from downstream clients.
SSL	Enables TLS/SSL on the downstream listener so that clients can connect to the proxy using wss:// or https://.
SSLOptions	Holds certificate paths, TLS version selection and OpenSSL tuning for the downstream TLS listener.
ThreadPool	Enables a thread pool that recycles worker threads instead of destroying them when proxied 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 proxy reads from or writes to each downstream connection.
Version	Read-only string with the sgcWebSockets library version embedded in the binary.