TsgcWebSocketClient Properties

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

Connection

Name	Description
Active	Opens or closes the WebSocket connection to the configured server.
Host	IP address or DNS name of the WebSocket server the client will connect to.
Port	TCP port used to connect to the WebSocket server.
URL	Write-only shortcut that populates Host, Port, TLS and parameters from a single WebSocket URL.
TLS	Enables a secure TLS/SSL connection to the WebSocket server.
IPVersion	Selects the IP protocol version (IPv4 or IPv6) used for the TCP connection.

Timeouts

Name	Description
ConnectTimeout	Maximum time in milliseconds the client waits for the TCP connection to be established.
ReadTimeout	Maximum time in milliseconds the client waits for incoming data before raising a read timeout.
WriteTimeout	Maximum duration in milliseconds for sending data to the other peer.

Reliability

Name	Description
HeartBeat	Sends periodic WebSocket ping frames to keep the connection alive.
WatchDog	Automatically reconnects to the server after an unexpected disconnection.

Security

Name	Description
Proxy	Routes the WebSocket connection through an HTTP or SOCKS proxy server.
Authentication	Configures the credentials and scheme used to authenticate the WebSocket handshake.
TLSOptions	Configures certificates, TLS version, ALPN, IOHandler and other secure-connection details used when TLS is enabled.

Messaging

Name	Description
QueueOptions	Queues outgoing Text, Binary and Ping messages so they are serialised on the connection thread.

Diagnostics

Name	Description
NotifyEvents	Controls how WebSocket events are dispatched to the main thread.
LogFile	Persists inbound and outbound socket traffic to a file, useful for debugging the wire protocol.
Version	Read-only string that returns the current sgcWebSockets library version.

Advanced

Name	Description
Extensions	Enables WebSocket protocol extensions such as per-message deflate compression.
Options	Customizes handshake headers and fine-tunes client behaviour such as fragmentation and UTF-8 validation.
Specifications	Selects which WebSocket wire specifications the client is allowed to negotiate.
Throttle	Limits the number of bits per second sent or received by the client socket.

Other

Name	Description
LoadBalancer	Connects to a sgcWebSockets Load Balancer server or to a manually defined pool of WebSocket servers.

All Properties (alphabetical)

Name	Description
Active	Opens or closes the WebSocket connection to the configured server.
Authentication	Configures the credentials and scheme used to authenticate the WebSocket handshake.
ConnectTimeout	Maximum time in milliseconds the client waits for the TCP connection to be established.
Extensions	Enables WebSocket protocol extensions such as per-message deflate compression.
HeartBeat	Sends periodic WebSocket ping frames to keep the connection alive.
Host	IP address or DNS name of the WebSocket server the client will connect to.
IPVersion	Selects the IP protocol version (IPv4 or IPv6) used for the TCP connection.
LoadBalancer	Connects to a sgcWebSockets Load Balancer server or to a manually defined pool of WebSocket servers.
LogFile	Persists inbound and outbound socket traffic to a file, useful for debugging the wire protocol.
NotifyEvents	Controls how WebSocket events are dispatched to the main thread.
Options	Customizes handshake headers and fine-tunes client behaviour such as fragmentation and UTF-8 validation.
Port	TCP port used to connect to the WebSocket server.
Proxy	Routes the WebSocket connection through an HTTP or SOCKS proxy server.
QueueOptions	Queues outgoing Text, Binary and Ping messages so they are serialised on the connection thread.
ReadTimeout	Maximum time in milliseconds the client waits for incoming data before raising a read timeout.
Specifications	Selects which WebSocket wire specifications the client is allowed to negotiate.
Throttle	Limits the number of bits per second sent or received by the client socket.
TLS	Enables a secure TLS/SSL connection to the WebSocket server.
TLSOptions	Configures certificates, TLS version, ALPN, IOHandler and other secure-connection details used when TLS is enabled.
URL	Write-only shortcut that populates Host, Port, TLS and parameters from a single WebSocket URL.
Version	Read-only string that returns the current sgcWebSockets library version.
WatchDog	Automatically reconnects to the server after an unexpected disconnection.
WriteTimeout	Maximum duration in milliseconds for sending data to the other peer.