wasmtimer 0.4.3

Time utils from std::time, tokio::time and tokio_util::time on WASM targets
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

use futures::task::{self, ArcWake};
use parking_lot::Mutex;
use std::convert::TryFrom;
use std::future::Future;
use std::pin::Pin;
use std::sync::Arc;
use std::task::Context;
use std::time::Duration;
use wasm_bindgen::{closure::Closure, JsCast};

use crate::js::set_timeout;
use crate::std::Instant;
use crate::timer::{Timer, TimerHandle};

/// Starts a background task, creates a `Timer`, and returns a handle to it.
///
/// > **Note**: Contrary to the original `futures-timer` crate, we don't have
/// >           any `forget()` method, as the task is automatically considered
/// >           as "forgotten".
pub(crate) fn run() -> TimerHandle {
    let timer = Timer::new();
    let handle = timer.handle();
    schedule_callback(Arc::new(Mutex::new(timer)), Duration::new(0, 0));
    handle
}

/// Calls `Window::setTimeout` with the given `Duration`. The callback wakes up the timer and
/// processes everything.
fn schedule_callback(timer: Arc<Mutex<Timer>>, when: Duration) {
    let cb = move || {
        let mut timer_lock = timer.lock();

        // We start by polling the timer. If any new `Delay` is created, the waker will be used
        // to wake up this task pre-emptively. As such, we pass a `Waker` that calls
        // `schedule_callback` with a delay of `0`.
        let waker = task::waker(Arc::new(Waker {
            timer: timer.clone(),
        }));
        let _ = Future::poll(Pin::new(&mut *timer_lock), &mut Context::from_waker(&waker));

        // Notify the timers that are ready.
        let now = Instant::now();
        timer_lock.advance_to(now);

        // A previous version of this function recursed in such a way as the strong count increased
        // From testing, this one doesn't (it remains at a constant 2)
        if Arc::strong_count(&timer) > 20 {
            return;
        }

        // We call `schedule_callback` again for the next event.
        let sleep_dur = timer_lock.next_event().map(|next_event| {
            if next_event > now {
                next_event - now
            } else {
                Duration::new(0, 0)
            }
        });
        drop(timer_lock);

        if let Some(sleep) = sleep_dur {
            schedule_callback(timer, sleep);
        }
    };

    #[cfg(feature = "tokio-test-util")]
    if super::clock::clock().paused() {
        cb();
    } else {
        let _ = set_timeout(
            Closure::once_into_js(cb).unchecked_ref(),
            i32::try_from(when.as_millis()).unwrap_or(0),
        )
        .unwrap();
    }

    #[cfg(not(feature = "tokio-test-util"))]
    let _ = set_timeout(
        Closure::once_into_js(cb).unchecked_ref(),
        i32::try_from(when.as_millis()).unwrap_or(0),
    )
    .unwrap();
}

struct Waker {
    timer: Arc<Mutex<Timer>>,
}

impl ArcWake for Waker {
    fn wake_by_ref(arc_self: &Arc<Self>) {
        schedule_callback(arc_self.timer.clone(), Duration::new(0, 0));
    }
}