ic-timers 0.22.6

Observable and recovery-aware timers for Internet Computer canisters
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

//! Observable and recovery-aware timer primitives for Internet Computer
//! canisters.
//!
//! `ic-timers` is a higher-level wrapper around `ic-cdk-timers`, which remains
//! the provider that arms and clears platform timers. This crate adds
//! bounded coordination, scheduling, and observation above it.
//!
//! The runtime executes `Once`, after-completion, and pre-armed synchronous
//! watchdog callbacks through one volatile canister-local registry.
//! Consumers retain durable application authority and synchronously reconstruct
//! retained registrations during their existing lifecycle hooks. Transient
//! remove-on-stop callbacks use direct registration with an initial schedule.
//! Direct registration returns scheduled authority only after provider binding;
//! only retained declarations may start inactive. [`TimerStart`] selects
//! retention together with the initial schedule. Registration capabilities can
//! observe exact armed provider-wakeup ownership without making snapshots
//! or observations into scheduling authority.
//! [`timer_inventory`] returns the epoch together with the complete ordered
//! timer set, including for an initialized empty registry.

#![forbid(unsafe_code)]
#![forbid(private_interfaces)]
#![deny(rustdoc::broken_intra_doc_links)]
mod callback;
mod control;
mod platform;
mod registry;
mod runtime;
mod schedule;
mod snapshot;

pub use callback::{
    AfterCompletionDecision, AfterCompletionRunResult, OnceDecision, OnceRunResult,
};
pub use registry::{MAX_TIMER_REGISTRATIONS, RegisterError};
pub use runtime::{
    AfterCompletionContext, AfterCompletionRegistration, OnceContext, OnceRegistration, TimerError,
    TimerReconcileState, TimerStart, WatchdogContext, WatchdogReconcileState, WatchdogRegistration,
    consecutive_expected_failures, initialize_runtime, reconcile_after_completion, reconcile_once,
    reconcile_watchdog, register_after_completion, register_once, register_watchdog,
    timer_inventory, timer_snapshot,
};
pub use schedule::{ScheduleError, TimerCadence, TimerSchedule};
pub use snapshot::{
    DeclarationLifetime, InactiveReason, MAX_TIMER_IDENTITY_COMPONENT_BYTES, MeasurementSummary,
    MemoryPageExtent, MemoryPageSample, MemoryPageSummary, OrdinaryRuntimeStateSnapshot,
    TimerCompletion, TimerCompletionOutcome, TimerControlFailure, TimerCounters,
    TimerDirectiveSnapshot, TimerEpoch, TimerIdentity, TimerIdentityError, TimerIdentityField,
    TimerInventorySnapshot, TimerLastOutcome, TimerObservabilitySnapshot, TimerOutcomeSnapshot,
    TimerPerformance, TimerPolicy, TimerProcessCondition, TimerRegistrationId,
    TimerRegistrationStatus, TimerRuntimeStateSnapshot, TimerSchedulingMode, TimerSnapshot,
    WatchdogAttemptStatus, WatchdogDecision, WatchdogRunResult, WatchdogRuntimeStateSnapshot,
};