Struct Heartbeat 

pub struct Heartbeat { /* private fields */ }

A periodic check-in for an always-on agent.

use std::time::Duration;
use autumn_plugin_agent::proactive::Heartbeat;

// Every 30 minutes during office hours, Oslo time, in the "ops" session.
let heartbeat = Heartbeat::cron("0 */30 8-18 * * Mon-Fri")
    .timezone("Europe/Oslo")
    .session("ops");

Implementations

impl Heartbeat

pub const TASK_NAME: &'static str = "agent_heartbeat"

The scheduled-task name the heartbeat registers.

pub fn every(interval: Duration) -> Self

Tick after a fixed delay from the end of the previous tick.

pub fn cron(expression: impl Into<String>) -> Self

Tick on a 6-field cron expression (sec min hour day month weekday).

pub fn timezone(self, timezone: impl Into<String>) -> Self

The IANA time zone for a cron schedule. Ignored for fixed delays.

pub fn prompt(self, prompt: impl Into<String>) -> Self

Replace the check-in prompt. Keep the HEARTBEAT_OK instruction in it, or every tick will be delivered.

pub fn session(self, session: impl Into<SessionId>) -> Self

Run ticks inside this session, so the agent sees earlier ticks.

pub fn memory_scope(self, scope: MemoryScope) -> Self

Bind memory to this scope instead of MemoryScope::agent.

pub const fn allow_actions(self) -> Self

Let ticks use every tool the app policy allows, not only read-only and internal ones.

pub const fn per_replica(self) -> Self

Run on every replica instead of once per tick across the fleet.

pub fn precheck<F, Fut>(self, check: F) -> Self

where F: Fn(AppState) -> Fut + Send + Sync + 'static, Fut: Future<Output = bool> + Send + 'static,

Skip a tick, before any model call, when check answers false.

pub const fn schedule(&self) -> &HeartbeatSchedule

The configured schedule.

pub fn validate(&self) -> Result<(), AgentError>

Check the schedule and prompt.

Errors

Returns ErrorKind::Config for an interval under one second, a blank cron expression, or a blank prompt.

pub async fn tick( &self, runtime: &AgentRuntime, state: &AppState, ) -> Result<Option<AgentOutcome>, AgentError>

Run one tick. Returns None when the precheck skipped it.

Errors

Returns AgentError when the run fails (see Agent::run).

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.