Struct HealthCheckConfig 

pub struct HealthCheckConfig {
    pub enabled: bool,
    pub heartbeat_timeout: Duration,
}

Configuration for WebSocket connection liveness detection.

A single timeout window controls when the SDK declares the connection dead: if no inbound frame (heartbeat, data, anything) arrives within heartbeat_timeout, the dispatch path emits ConnectionEvent::HeartbeatTimeout and exits, which lets the reconnect manager take over.

Fields

enabled: bool

Whether liveness detection is active. Default: true (changed from false in 2.x). Use HealthCheckConfig::disabled to opt out — discouraged outside test environments because a silent connection won’t surface until the OS times out the underlying TCP, typically hours later.

heartbeat_timeout: Duration

Maximum allowed gap between inbound frames before declaring the connection dead.

Default: 35s (the Fugle server emits a heartbeat every 30s; 5s buffer absorbs network jitter). Use HealthCheckConfig::with_timeout to construct with validation.

Implementations

impl HealthCheckConfig

pub fn with_timeout( timeout: Duration, ) -> Result<HealthCheckConfig, MarketDataError>

Construct an enabled config with the given timeout.

Returns MarketDataError::ConfigError if timeout is below the absolute sanity floor (MIN_HEARTBEAT_TIMEOUT_MS). Note: this only enforces a floor, not a value that’s actually safe against the live server’s heartbeat period. See the constant’s docs.

Errors

Returns MarketDataError on transport, protocol, deserialization, validation, or peer-initiated failures.

pub fn disabled() -> HealthCheckConfig

Construct a disabled config. Without liveness detection a stalled connection won’t surface until the OS times out the underlying TCP — typically hours on Linux defaults.

Trait Implementations

impl Clone for HealthCheckConfig

fn clone(&self) -> HealthCheckConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HealthCheckConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for HealthCheckConfig

fn default() -> HealthCheckConfig

Returns the “default value” for a type.