TsgcTCPClient › Properties

TsgcTCPClient Properties

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

Connection

Name	Description
Active	Opens or closes the raw TCP connection to the configured server.
Host	IP address or DNS name of the TCP server the client will connect to.
Port	TCP port used to connect to the remote server.
TLS	Enables a secure TLS/SSL connection to the TCP server.
IPVersion	Selects the IP protocol version (IPv4 or IPv6) used for the TCP connection.
Proxy	Routes the TCP connection through an HTTP or SOCKS proxy server.

Binding

Name	Description
BoundIP	Local IP address the client socket is bound to before connecting.
BoundPort	Local TCP port the client socket is bound to before connecting.
BoundPortMin	Lower bound of the local port range when binding the outbound connection to a range of ports.
BoundPortMax	Upper bound of the local port range when binding the outbound connection to a range of ports.

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.

Socket

Name	Description
UseNagle	Enables or disables Nagle's algorithm (TCP_NODELAY) on the client socket.
LingerState	Configures the SO_LINGER socket option used when the client closes the connection.
TCPKeepAlive	Enables OS-level TCP keep-alive probes on the client socket.

Reliability

Name	Description
HeartBeat	Triggers a periodic application-level heartbeat to keep the connection alive and detect stalls.
WatchDog	Automatically reconnects to the server after an unexpected disconnection.
Throttle	Limits the number of bits per second sent or received by the client socket.

Security

Name	Description
TLSOptions	Configures certificates, TLS version, ALPN, IOHandler and other secure-connection details used when TLS is enabled.

Advanced

Name	Description
QueueOptions	Queues outgoing text, binary and ping messages so they are serialised on the connection thread.
NotifyEvents	Controls how connection events are dispatched to the main thread.

Diagnostics

Name	Description
LogFile	Persists inbound and outbound socket traffic to a file, useful for debugging the wire protocol.

All Properties (alphabetical)

Name	Description
Active	Opens or closes the raw TCP connection to the configured server.
BoundIP	Local IP address the client socket is bound to before connecting.
BoundPort	Local TCP port the client socket is bound to before connecting.
BoundPortMax	Upper bound of the local port range when binding the outbound connection to a range of ports.
BoundPortMin	Lower bound of the local port range when binding the outbound connection to a range of ports.
ConnectTimeout	Maximum time in milliseconds the client waits for the TCP connection to be established.
HeartBeat	Triggers a periodic application-level heartbeat to keep the connection alive and detect stalls.
Host	IP address or DNS name of the TCP server the client will connect to.
IPVersion	Selects the IP protocol version (IPv4 or IPv6) used for the TCP connection.
LingerState	Configures the SO_LINGER socket option used when the client closes the connection.
LogFile	Persists inbound and outbound socket traffic to a file, useful for debugging the wire protocol.
NotifyEvents	Controls how connection events are dispatched to the main thread.
Port	TCP port used to connect to the remote server.
Proxy	Routes the TCP 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.
TCPKeepAlive	Enables OS-level TCP keep-alive probes on the client socket.
Throttle	Limits the number of bits per second sent or received by the client socket.
TLS	Enables a secure TLS/SSL connection to the TCP server.
TLSOptions	Configures certificates, TLS version, ALPN, IOHandler and other secure-connection details used when TLS is enabled.
UseNagle	Enables or disables Nagle's algorithm (TCP_NODELAY) on the client socket.
WatchDog	Automatically reconnects to the server after an unexpected disconnection.
WriteTimeout	Maximum duration in milliseconds for sending data to the other peer.