ic-timers 0.2.0

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

//! Direct boundary to the Internet Computer timer provider.
//!
//! Recurrence, identity, arbitration, inventory, and measurement belong above
//! this module.

use ic_cdk_timers::{
    TimerId as CdkTimerId, clear_timer as cdk_clear_timer, set_timer as cdk_set_timer,
};
use std::{future::Future, time::Duration};

/// Opaque handle for one armed platform timer.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct TimerHandle(CdkTimerId);

/// Arm one asynchronous one-shot callback.
///
/// Higher-level policies should use one-shots even for recurring work so they
/// can control exactly when a successor becomes authoritative.
pub fn set_timer(delay: Duration, task: impl Future<Output = ()> + 'static) -> TimerHandle {
    TimerHandle(cdk_set_timer(delay, task))
}

/// Clear one still-armed platform callback.
pub fn clear_timer(handle: TimerHandle) {
    cdk_clear_timer(handle.0);
}