Skip to main content

Module workloop

Module workloop 

Source
Expand description

Workloop engine services: cadence dead-man, tolerance sweep, iteration boundary, hatch (workloop design brief, Leg 2). Workloop engine services (workloop design brief, Leg 2).

The perpetual-work half of the engine: an engine-side cadence dead-man switch (R4.3), tolerance accounting on the one alarm path (R4.2), iteration-as-generation via the continue-as-new boundary (R3.1), invariant current-state records with declared retention (R7/R8), suspended residency between fires (R13.3), and the detached hatch with mandatory dedupe identity (R13.1).

Re-exports§

pub use declared::spec_from_contract;
pub use error::WorkloopError;
pub use hatch::HatchOutcome;
pub use health::UnconfirmedEvidence;
pub use health::observe_confirmed;
pub use health::observe_unconfirmed;
pub use health::take_alarm;
pub use iteration::IterationOutcome;
pub use iteration::WorkloopIterationClose;
pub use retire::RETIRE_ARITY;
pub use retire::RETIRE_ENTRY;
pub use retire::RetireInvocation;
pub use service::LoopEventSink;
pub use service::SweepReport;
pub use service::WorkloopService;
pub use service::WorkloopWaker;
pub use sink::EngineLoopEventSink;
pub use wake::EngineWorkloopWaker;
pub use windows::advance_window;
pub use windows::initial_window;
pub use windows::next_check_at;

Modules§

close
The iteration-close path, shared by the engine API verb and the close_iteration/3 NIF.
declared
The bridge from a DEPLOYED package’s workloop declaration (aion_package::WorkloopContract, compiled from the .awl header and bound into package identity) to the engine’s runtime WorkloopSpec.
error
Typed errors for the workloop engine services.
hatch
The detached hatch (R13.1): a top-level workflow start with a mandatory dedupe identity, from workflow and workloop documents alike.
health
Pure tolerance accounting for workloop invariants (R2.3/R4.2).
iteration
Iteration close and retirement: the continue-as-new machinery, surfaced for workloops (R3.1) — never a second loop mechanism.
retire
The retire-body invocation protocol (S3).
service
The engine-side cadence service: dead-man switch, tolerance sweep, wake.
sink
Production LoopEventSink: every workloop event through the loop’s ONE Recorder.
wake
Production WorkloopWaker: bring a suspended loop’s current generation to a live process (wake = load carry, run iteration, suspend — R13.3).
windows
Pure cadence-window arithmetic (R4.3/R13.3).

Functions§

hatch_identity
Re-export of the one identity derivation both document kinds share. Derives the deterministic workflow id for a hatch (R13.1 mandatory dedupe).