Struct Heartbeat 

pub struct Heartbeat { /* private fields */ }

Heartbeat mechanism for long-running nodes

Nodes can send heartbeats to indicate they are still active, preventing idle timeout detection. The heartbeat carries an unbounded channel sender that signals the engine’s idle-timeout watchdog each time ping() is called.

Create paired heartbeat and watcher with Heartbeat::new_pair:

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

let (heartbeat, mut watcher) = Heartbeat::new_pair();
heartbeat.ping().unwrap();
assert!(watcher.is_alive(Duration::from_secs(10)));

Implementations

impl Heartbeat

pub const fn new(tx: UnboundedSender<()>) -> Self

Create a new heartbeat from an unbounded sender

pub fn new_pair() -> (Self, HeartbeatWatcher)

Create a paired heartbeat sender and watcher

Returns a (Heartbeat, HeartbeatWatcher) pair connected by an unbounded channel. The watcher can detect staleness by checking whether heartbeats arrived within the idle timeout.

pub fn ping(&self) -> Result<(), SendError<()>>

Send a heartbeat signal

Errors

Returns Err if the receiver has been dropped (engine shutdown).

Trait Implementations

impl Clone for Heartbeat

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Heartbeat

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

Formats the value using the given formatter.

impl Default for Heartbeat

fn default() -> Self

Returns the “default value” for a type.