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 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
use std::cmp::{Eq, Ord, Ordering};
use std::collections::BinaryHeap;
use std::future::Future;
use std::pin::Pin;
use std::sync::{
atomic::{AtomicBool, Ordering::SeqCst},
Arc, Condvar, Mutex,
};
use std::task::{Context, Poll};
// scheduler unit
struct Task {
time: std::time::Instant,
is_deleted: Arc<AtomicBool>,
callback: Box<dyn FnOnce() + Send>,
}
impl Task {
fn call(self) {
(self.callback)();
}
}
impl PartialOrd for Task {
#[inline]
fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
Some(other.time.cmp(&self.time))
}
}
impl PartialEq for Task {
#[inline]
fn eq(&self, other: &Self) -> bool {
self.time == other.time
}
}
impl Ord for Task {
#[inline]
fn cmp(&self, other: &Self) -> Ordering {
other.time.cmp(&self.time)
}
}
impl Eq for Task {}
/// Timer store all timeout callback base on binaryHeap;
/// will duration is reach
///
/// Example
///
/// ```
/// use swnb_timer::Timer;
/// use std::time::Duration;
///
/// let timer = Timer::new();
///
/// timer.set_timeout(||{
/// println!("after 1 sec");
/// },Duration::from_secs(1));
///
/// std::thread::sleep(Duration::from_secs(2));
/// ```
pub struct Timer {
thread_handler: std::thread::JoinHandle<()>,
cond: Arc<(Condvar, Mutex<BinaryHeap<Task>>)>,
}
impl Default for Timer {
fn default() -> Self {
Self::new()
}
}
impl Timer {
/// create new Timer, this method will create one thread to handle all task base on binaryHeap;
///
/// # Examples
///
/// Basic usage:
/// ```
/// use swnb_timer::Timer;
/// use std::time::Duration;
///
/// let timer = Timer::new();
///
/// timer.set_timeout(||{
/// println!("after 1 sec");
/// },Duration::from_secs(1));
///
/// timer.set_timeout(||{
/// println!("after 2 sec");
/// },Duration::from_secs(2));
///
/// std::thread::sleep(Duration::from_secs(3));
///
/// ```
///
/// Async usage:
/// ```
/// use swnb_timer::Timer;
/// use std::time::Duration;
///
/// let timer = Timer::new();
///
/// let async_block = async {
/// timer.wait(Duration::from_secs(1)).await;
/// println!("after 1 sec");
/// };
/// // blocking_on(async_block);
/// ```
///
pub fn new() -> Self {
let heap = BinaryHeap::new();
let cond = Arc::new((Condvar::new(), Mutex::new(heap)));
let thread_handler = Timer::handle_task(cond.clone());
Timer {
thread_handler,
cond,
}
}
fn handle_task(cond: Arc<(Condvar, Mutex<BinaryHeap<Task>>)>) -> std::thread::JoinHandle<()> {
std::thread::spawn(move || {
let mut locker = cond.1.lock().unwrap();
loop {
loop {
match locker.peek() {
Some(&Task {
time,
ref is_deleted,
..
}) => {
if is_deleted.load(SeqCst) {
locker.pop();
} else {
let now = std::time::Instant::now();
if time < now {
break;
} else {
let (new_locker, _) =
cond.0.wait_timeout(locker, time - now).unwrap();
locker = new_locker;
}
}
}
None => {
locker = cond.0.wait(locker).unwrap();
}
}
}
while let Some(task) = locker.pop() {
if task.time < std::time::Instant::now() && !task.is_deleted.load(SeqCst) {
task.call();
} else {
locker.push(task);
break;
}
}
}
})
}
/// set_timeout accept two arguments, callback and duration;
/// callback will run after duration;
/// if you want to cancel callback before the deadline,
/// set_timeout return cancel function,
/// run it will cancel current timeout callback;
///
/// # Examples
///
/// set_timeout:
///
/// ```
/// use swnb_timer::Timer;
/// use std::time::Duration;
///
/// let timer = Timer::new();
///
/// timer.set_timeout(||{
/// println!("after 1 sec");
/// },Duration::from_secs(1));
///
/// timer.set_timeout(||{
/// println!("after 2 sec");
/// },Duration::from_secs(2));
///
/// std::thread::sleep(Duration::from_secs(3));
/// ```
///
/// cancel_callback:
///
/// ```
/// use swnb_timer::Timer;
/// use std::time::Duration;
///
/// let timer = Timer::new();
///
/// let cancel = timer.set_timeout(||{
/// println!("after 2 sec");
/// },Duration::from_secs(2));
///
/// timer.set_timeout(move ||{
/// cancel();
/// println!("cancel previous timeout callback");
/// },Duration::from_secs(1));
///
/// std::thread::sleep(Duration::from_secs(3));
/// ```
pub fn set_timeout(
&self,
callback: impl FnOnce() + 'static + Send,
duration: std::time::Duration,
) -> impl FnOnce() + Sync + 'static {
let now = std::time::Instant::now();
let is_deleted = Arc::new(AtomicBool::new(false));
let task = Task {
callback: Box::new(callback),
is_deleted: is_deleted.clone(),
time: now + duration,
};
let mut locker = self.cond.1.lock().unwrap();
locker.push(task);
drop(locker);
self.cond.0.notify_one();
move || is_deleted.store(true, SeqCst)
}
/// wait for `duration` time
///
/// Examples
///
/// ```
/// use swnb_timer::Timer;
/// use std::time::Duration;
///
/// let timer = Timer::new();
///
/// let async_block = async {
/// timer.wait(Duration::from_secs(1)).await;
/// };
///
/// // blocking_on(async_block);
/// ```
///
pub async fn wait(&self, duration: std::time::Duration) {
let future_timer = FutureTimer::new(duration, self);
future_timer.await
}
}
// FutureTimer impl Future
// for Timer to do async wait
struct FutureTimer<'a> {
duration: std::time::Duration,
is_set_timeout: AtomicBool,
is_resolved: Arc<AtomicBool>,
timer: &'a Timer,
}
impl<'a> Future for FutureTimer<'a> {
type Output = ();
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
let result = self
.is_set_timeout
.compare_exchange(false, true, SeqCst, SeqCst);
if result.is_ok() {
let is_resolved = self.is_resolved.clone();
let waker = cx.waker().clone();
let _ = self.timer.set_timeout(
move || {
is_resolved.store(true, SeqCst);
waker.wake();
},
self.duration,
);
Poll::Pending
} else if self.is_resolved.load(SeqCst) {
Poll::Ready(())
} else {
Poll::Pending
}
}
}
impl<'a> FutureTimer<'a> {
fn new<'b: 'a>(duration: std::time::Duration, timer: &'b Timer) -> Self {
FutureTimer {
duration,
is_set_timeout: AtomicBool::new(false),
is_resolved: Arc::new(AtomicBool::new(false)),
timer,
}
}
}