Struct HeartbeatConfig 

pub struct HeartbeatConfig { /* private fields */ }

Configuration for a HeartbeatStream.

Holds the heartbeat interval, hard timeout, and callback function. Created via HeartbeatConfig::new().

Example

use loopctl::stream::heartbeat::{HeartbeatConfig, HeartbeatData};
use std::time::Duration;

let config = HeartbeatConfig::new(
    Duration::from_secs(30),
    Duration::from_secs(600),
    Box::new(|_data: HeartbeatData| {}),
);
assert_eq!(config.heartbeat_interval(), Duration::from_secs(30));
assert_eq!(config.timeout(), Duration::from_secs(600));

Implementations

impl HeartbeatConfig

pub fn new( heartbeat_interval: Duration, timeout: Duration, on_heartbeat: HeartbeatCallback, ) -> Self

Create a new heartbeat configuration.

Arguments

• heartbeat_interval — How often to fire the callback.
• timeout — Maximum stream duration before returning an error.
• on_heartbeat — Callback invoked at each interval.

Example

use loopctl::stream::heartbeat::{HeartbeatConfig, HeartbeatData};
use std::time::Duration;

let config = HeartbeatConfig::new(
    Duration::from_secs(15),
    Duration::from_secs(300),
    Box::new(|data: HeartbeatData| {
        println!("heartbeat: {:.1}s elapsed", data.elapsed.as_secs_f64());
    }),
);

pub fn heartbeat_interval(&self) -> Duration

Returns the configured heartbeat interval.

pub fn timeout(&self) -> Duration

Returns the configured hard timeout.

Trait Implementations

impl Debug for HeartbeatConfig

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

Formats the value using the given formatter.