Configuration for the client. More...
#include <client_options.hpp>
Collaboration diagram for client_options:
Public Attributes | |
| std::string | host = "localhost" |
| Host to connect to. | |
| std::uint16_t | port = 55555 |
| Port to connect to. | |
| std::string | client_identifier = "ores-client" |
| Client identifier to send when performing the handshake. | |
| bool | verify_certificate = true |
| Whether to verify the server's certificate. | |
| bool | heartbeat_enabled = true |
| Whether to enable heartbeat (ping/pong) for connection monitoring. | |
| std::uint32_t | heartbeat_interval_seconds = 30 |
| Interval between heartbeat pings in seconds. | |
| retry_options | retry |
| Retry and reconnection options. | |
| std::uint8_t | supported_compression = messaging::COMPRESSION_SUPPORT_ALL |
| Bitmask of compression types supported by this client. | |
Detailed Description
Configuration for the client.
Member Data Documentation
◆ heartbeat_enabled
| bool heartbeat_enabled = true |
Whether to enable heartbeat (ping/pong) for connection monitoring.
When enabled, the client will periodically send ping messages to the server to detect disconnections proactively.
◆ heartbeat_interval_seconds
| std::uint32_t heartbeat_interval_seconds = 30 |
Interval between heartbeat pings in seconds.
Default is 30 seconds. Lower values provide faster disconnect detection but increase network traffic.
◆ supported_compression
| std::uint8_t supported_compression = messaging::COMPRESSION_SUPPORT_ALL |
Bitmask of compression types supported by this client.
Used during handshake to negotiate compression with the server. Default is COMPRESSION_SUPPORT_ALL (zlib, gzip, bzip2). Set to 0 to disable compression.
