Struct HeartbeatWatcher 

pub struct HeartbeatWatcher { /* private fields */ }

Watches heartbeats and detects staleness for idle timeout detection

The watcher receives heartbeat signals from a paired Heartbeat sender. Call is_alive to check whether a heartbeat was received within the specified idle timeout duration.

Examples

use juncture_core::Heartbeat;
use std::time::Duration;

let (heartbeat, mut watcher) = Heartbeat::new_pair();

// Immediately after creation, the watcher considers the source alive
assert!(watcher.is_alive(Duration::from_secs(60)));

// After sending a heartbeat and checking with a short timeout
heartbeat.ping().unwrap();
assert!(watcher.is_alive(Duration::from_secs(10)));

Implementations

impl HeartbeatWatcher

pub fn new(rx: UnboundedReceiver<()>) -> Self

Create a new heartbeat watcher from an unbounded receiver

pub fn is_alive(&mut self, idle_timeout: Duration) -> bool

Check if the watched heartbeat source is still alive

Drains any pending heartbeat signals and returns true if at least one heartbeat was received within idle_timeout. Returns false if no heartbeat was received within the idle timeout duration.

This is a non-blocking check.

Trait Implementations

impl Debug for HeartbeatWatcher

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

Formats the value using the given formatter.