ic_timers/
lib.rs

1//! Observable and recovery-aware timer primitives for Internet Computer
2//! canisters.
3//!
4//! `ic-timers` is a higher-level wrapper around `ic-cdk-timers`, which remains
5//! the provider that arms and clears platform timers. This crate adds
6//! bounded coordination, scheduling, and observation above it.
7//!
8//! The runtime executes `Once`, after-completion, and pre-armed synchronous
9//! watchdog callbacks through one volatile canister-local registry.
10//! Consumers retain durable application authority and synchronously reconstruct
11//! retained registrations during their existing lifecycle hooks. Transient
12//! remove-on-stop callbacks use direct registration. Registration capabilities
13//! can observe exact armed provider-wakeup ownership without making snapshots
14//! or observations into scheduling authority.
15//! [`timer_inventory`] returns the epoch together with the complete ordered
16//! timer set, including for an initialized empty registry.
17
18#![forbid(unsafe_code)]
19#![forbid(private_interfaces)]
20#![deny(rustdoc::broken_intra_doc_links)]
21mod control;
22mod platform;
23mod registry;
24mod runtime;
25mod schedule;
26mod snapshot;
27
28pub use registry::{MAX_TIMER_REGISTRATIONS, RegisterError};
29pub use runtime::{
30    AfterCompletionContext, AfterCompletionRegistration, OnceContext, OnceRegistration, TimerError,
31    TimerReconcileState, WatchdogContext, WatchdogReconcileState, WatchdogRegistration,
32    consecutive_expected_failures, initialize_runtime, reconcile_after_completion, reconcile_once,
33    reconcile_watchdog, register_after_completion, register_once, register_watchdog,
34    timer_inventory, timer_snapshot,
35};
36pub use schedule::{ScheduleError, TimerCadence, TimerDirective, TimerSchedule};
37pub use snapshot::{
38    DeclarationLifetime, InactiveReason, MAX_TIMER_IDENTITY_COMPONENT_BYTES, MeasurementSummary,
39    MemoryPageExtent, MemoryPageSample, MemoryPageSummary, OrdinaryRuntimeStateSnapshot,
40    TimerCompletion, TimerCompletionOutcome, TimerControlFailure, TimerCounters,
41    TimerDirectiveSnapshot, TimerEpoch, TimerIdentity, TimerIdentityError, TimerIdentityField,
42    TimerInventorySnapshot, TimerLastOutcome, TimerObservabilitySnapshot, TimerOutcomeSnapshot,
43    TimerPerformance, TimerPolicy, TimerProcessCondition, TimerRegistrationId,
44    TimerRegistrationStatus, TimerRunResult, TimerRuntimeStateSnapshot, TimerSchedulingMode,
45    TimerSnapshot, WatchdogAttemptSnapshot, WatchdogAttemptStatus, WatchdogDecision,
46    WatchdogRunResult, WatchdogRuntimeStateSnapshot,
47};
ic_timers/lib.rs

ic_timers/
lib.rs
