canic 0.21.8

Canic — a canister orchestration and management toolkit for the Internet Computer
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

// -----------------------------------------------------------------------------
// Timer macros
// -----------------------------------------------------------------------------

// Perf-instrumented timer helpers that auto-label with module + function name.
//
// These macros wrap `TimerApi` so callers can schedule work without manually
// threading labels. Labels are constructed as `module_path!()::function_name`.

///
/// timer
/// Schedule a one-shot timer with an auto-generated label.
///
/// # Examples
/// - `timer!(Duration::from_secs(5), do_cleanup);`
/// - `timer!(Duration::ZERO, my_task, arg1, arg2);`
///
#[macro_export]
macro_rules! timer {
    ($delay:expr, $func:path $(, $($args:tt)*)? ) => {{
        let label = concat!(module_path!(), "::", stringify!($func));
        $crate::__internal::core::api::timer::TimerApi::set_lifecycle_timer(
            $delay,
            label,
            $func($($($args)*)?),
        )
    }};
}

///
/// timer_guarded
/// Schedule a one-shot timer if none is already scheduled for the slot.
/// Returns true when a new timer was scheduled.
///
/// # Examples
/// - `timer_guarded!(MY_TIMER, Duration::from_secs(5), do_cleanup);`
/// - `timer_guarded!(MY_TIMER, Duration::ZERO, my_task, arg1, arg2);`
///
#[macro_export]
macro_rules! timer_guarded {
    ($slot:path, $delay:expr, $func:path $(, $($args:tt)*)? ) => {{
        let label = concat!(module_path!(), "::", stringify!($func));
        $crate::__internal::core::api::timer::TimerApi::set_guarded(
            &$slot,
            $delay,
            label,
            $func($($($args)*)?),
        )
    }};
}

///
/// timer_interval
/// Schedule a repeating timer with an auto-generated label.
///
/// # Examples
/// - `timer_interval!(Duration::from_secs(60), heartbeat);`
/// - `timer_interval!(Duration::from_secs(10), tick, state.clone());`
///
#[macro_export]
macro_rules! timer_interval {
    ($interval:expr, $func:path $(, $($args:tt)*)? ) => {{
        let label = concat!(module_path!(), "::", stringify!($func));
        $crate::__internal::core::api::timer::TimerApi::set_interval(
            $interval,
            label,
            move || $func($($($args)*)?),
        )
    }};
}

///
/// timer_interval_guarded
/// Schedule an init timer that installs a repeating timer for the slot.
/// Returns true when a new timer was scheduled.
///
/// # Examples
/// - `timer_interval_guarded!(MY_TIMER, Duration::ZERO, init_task; Duration::from_secs(60), tick);`
/// - `timer_interval_guarded!(MY_TIMER, Duration::from_secs(2), init; Duration::from_secs(10), tick, state.clone());`
///
#[macro_export]
macro_rules! timer_interval_guarded {
    (
        $slot:path,
        $init_delay:expr,
        $init_func:path $(, $($init_args:tt)*)?
        ;
        $interval:expr,
        $tick_func:path $(, $($tick_args:tt)*)?
    ) => {{
        let init_label = concat!(module_path!(), "::", stringify!($init_func));
        let tick_label = concat!(module_path!(), "::", stringify!($tick_func));

        $crate::__internal::core::api::timer::TimerApi::set_guarded_interval(
            &$slot,
            $init_delay,
            init_label,
            move || $init_func($($($init_args)*)?),
            $interval,
            tick_label,
            move || $tick_func($($($tick_args)*)?),
        )
    }};
}