TsgcHTTP2Client › Properties

TsgcHTTP2Client Properties

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

Connection

Name	Description
Active	Opens or closes the HTTP/2 connection to the remote server.
Host	IP address or DNS name of the HTTP/2 server the client will connect to.
Port	TCP port used to connect to the HTTP/2 server.
TLS	Enables a secure TLS connection, which is normally required by HTTP/2 servers.
IPVersion	Selects the IP protocol version (IPv4 or IPv6) used for the HTTP/2 TCP connection.
Proxy	Routes the HTTP/2 connection through an HTTP CONNECT tunnel or SOCKS proxy server.

Timeouts

Name	Description
ConnectTimeout	Maximum time in milliseconds the client waits for the TCP/TLS connection and HTTP/2 preface to complete.
ReadTimeout	Maximum time in milliseconds to wait for a synchronous HTTP/2 response before raising a timeout.

Reliability

Name	Description
HeartBeat	Sends periodic HTTP/2 PING frames to keep the connection alive.
WatchDog	Automatically reconnects to the HTTP/2 server after an unexpected disconnection.
Throttle	Limits the number of bits per second sent or received by the HTTP/2 socket.

Security

Name	Description
Authentication	Configures the credentials used to authenticate HTTP/2 requests, including OAuth2 and JWT tokens.
TLSOptions	Configures certificates, TLS version, ALPN, IOHandler and other secure-connection details used for HTTP/2 over TLS.

HTTP/2

Name	Description
Request	Default HTTP/2 request parameters (headers, user-agent, accept, content-type) applied to every outgoing request.
Settings	HTTP/2 SETTINGS frame parameters (RFC 7540 section 6.5) announced to the server at connection time.
HTTP2Options	Client-side tuning options for HTTP/2, including how fragmented DATA frames are delivered to the application.

Diagnostics

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

All Properties (alphabetical)

Name	Description
Active	Opens or closes the HTTP/2 connection to the remote server.
Authentication	Configures the credentials used to authenticate HTTP/2 requests, including OAuth2 and JWT tokens.
ConnectTimeout	Maximum time in milliseconds the client waits for the TCP/TLS connection and HTTP/2 preface to complete.
HeartBeat	Sends periodic HTTP/2 PING frames to keep the connection alive.
Host	IP address or DNS name of the HTTP/2 server the client will connect to.
HTTP2Options	Client-side tuning options for HTTP/2, including how fragmented DATA frames are delivered to the application.
IPVersion	Selects the IP protocol version (IPv4 or IPv6) used for the HTTP/2 TCP connection.
LogFile	Persists inbound and outbound HTTP/2 frames to a file, useful for wire-level debugging.
NotifyEvents	Controls how HTTP/2 events are dispatched to the main thread.
Port	TCP port used to connect to the HTTP/2 server.
Proxy	Routes the HTTP/2 connection through an HTTP CONNECT tunnel or SOCKS proxy server.
ReadTimeout	Maximum time in milliseconds to wait for a synchronous HTTP/2 response before raising a timeout.
Request	Default HTTP/2 request parameters (headers, user-agent, accept, content-type) applied to every outgoing request.
Settings	HTTP/2 SETTINGS frame parameters (RFC 7540 section 6.5) announced to the server at connection time.
Throttle	Limits the number of bits per second sent or received by the HTTP/2 socket.
TLS	Enables a secure TLS connection, which is normally required by HTTP/2 servers.
TLSOptions	Configures certificates, TLS version, ALPN, IOHandler and other secure-connection details used for HTTP/2 over TLS.
Version	Read-only string that returns the current sgcWebSockets library version.
WatchDog	Automatically reconnects to the HTTP/2 server after an unexpected disconnection.