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
///! Implementation of the dynamic timeout with the std thread library
use anyhow::{bail, Result};
use std::{
    sync::{
        atomic::{AtomicBool, Ordering},
        mpsc, Arc, Mutex,
    },
    thread::{self, JoinHandle},
    time::Duration,
};

type DurationVec = Arc<Mutex<Vec<Duration>>>;

/// Dynamic timeout, standard implementation with std::thread. Automaticcaly
/// join on drop.
/// # Example
/// ```
/// use std::time::Duration;
/// use dyn_timeout::std_thread::DynTimeout;
///
/// const TWENTY: Duration = Duration::from_millis(20);
///
/// let dyn_timeout = DynTimeout::new(TWENTY, || {
///    println!("after forty milliseconds");
/// });
/// dyn_timeout.add(TWENTY).unwrap();
/// ```
pub struct DynTimeout {
    thread: Option<JoinHandle<()>>,
    cancelled: Arc<AtomicBool>,
    sender: mpsc::Sender<()>,
    durations: DurationVec,
}

impl DynTimeout {
    /// Create a new dynamic timeout in a new thread. Execute the callback
    /// function in the separated thread after a given duration.
    /// The created thread join automatically on drop timeout without dismiss
    /// the callback execution.
    ///
    /// # Example
    /// ```
    /// use std::time::Duration;
    /// use dyn_timeout::std_thread::DynTimeout;
    ///
    /// const TWENTY: Duration = Duration::from_millis(20);
    ///
    /// let dyn_timeout = DynTimeout::new(TWENTY, || {
    ///    println!("after forty milliseconds");
    /// });
    /// dyn_timeout.add(TWENTY).unwrap();
    /// ```
    pub fn new(dur: Duration, callback: fn() -> ()) -> Self {
        let durations: DurationVec = Arc::new(Mutex::new(vec![Duration::ZERO, dur]));
        let thread_vec = durations.clone();
        let cancelled = Arc::new(AtomicBool::new(false));
        let thread_cancelled = cancelled.clone();
        let (sender, receiver) = mpsc::channel::<()>();
        Self {
            thread: Some(thread::spawn(move || {
                while let Some(dur) = thread_vec.lock().unwrap().pop() {
                    let _ = receiver.recv_timeout(dur);
                }
                if !thread_cancelled.load(Ordering::Relaxed) {
                    callback();
                }
            })),
            cancelled,
            sender,
            durations,
        }
    }
    /// Increase the delay before the timeout.
    ///
    /// # Return
    /// Return a result with an error if the timeout already appened or it failed
    /// to increase the delay for any other reason.
    /// Otherwise it return an empty success.
    ///
    /// # Example
    /// ```
    /// use std::time::Duration;
    /// use dyn_timeout::std_thread::DynTimeout;
    ///
    /// const TWENTY: Duration = Duration::from_millis(20);
    /// let dyn_timeout = DynTimeout::new(TWENTY, || {
    ///    println!("after forty milliseconds");
    /// });
    /// dyn_timeout.add(TWENTY).unwrap();
    /// ```
    pub fn add(&self, dur: Duration) -> Result<()> {
        match self.durations.lock() {
            Ok(mut durations) => {
                if durations.is_empty() {
                    bail!("Timeout already reached")
                }
                durations.push(dur);
                Ok(())
            }
            Err(err) => bail!(err.to_string()),
        }
    }
    /// Try to decrease the delay before the timeout. (bad precision, work in progress)
    ///
    /// # Return
    /// Return a result with an error if the timeout already appened or it failed
    /// to decrease the delay for any other reason.
    /// Otherwise it return an empty success.
    ///
    /// # Example
    /// ```
    /// use std::time::Duration;
    /// use dyn_timeout::std_thread::DynTimeout;
    ///
    /// const TWENTY: Duration = Duration::from_millis(20);
    /// const TEN: Duration = Duration::from_millis(10);
    ///
    /// let dyn_timeout = DynTimeout::new(TWENTY, || {
    ///    println!("after some milliseconds");
    /// });
    /// dyn_timeout.add(TEN).unwrap();
    /// dyn_timeout.add(TWENTY).unwrap();
    /// dyn_timeout.sub(TEN).unwrap();
    /// ```
    pub fn sub(&self, dur: Duration) -> Result<()> {
        let mut durations = match self.durations.lock() {
            Ok(durations) => {
                if durations.is_empty() {
                    bail!("Timeout already reached")
                } else {
                    durations
                }
            }
            Err(err) => bail!(err.to_string()),
        };
        let mut pop_dur = Duration::default();
        while pop_dur < dur && durations.len() > 1 {
            pop_dur += durations.pop().unwrap();
        }
        if pop_dur > dur {
            durations.push(pop_dur - dur);
        }
        Ok(())
    }
    /// Dismiss the timeout callback and cancel all delays added.
    /// Stop immediatelly all waiting process and join the created thread.
    ///
    /// # Return
    /// Return a result with an error if the timeout if the program failed to
    /// clear the delays.
    /// Otherwise it return an empty success.
    ///
    /// # Example
    /// ```
    /// use std::time::Duration;
    /// use dyn_timeout::std_thread::DynTimeout;
    ///
    /// const TWENTY: Duration = Duration::from_millis(20);
    /// const TEN: Duration = Duration::from_millis(10);
    ///
    /// let mut dyn_timeout = DynTimeout::new(TWENTY, || {
    ///    println!("never append");
    /// });
    /// dyn_timeout.add(TEN).unwrap();
    /// // cancel the last ten milliseconds and dismiss the callback
    /// dyn_timeout.cancel().unwrap();
    /// ```
    pub fn cancel(&mut self) -> Result<()> {
        match self.durations.lock() {
            Ok(mut durations) => {
                self.cancelled.store(true, Ordering::Release);
                durations.clear();
                self.sender.send(())?;
            }
            Err(err) => bail!(err.to_string()),
        };
        self.join()?;
        self.thread = None;
        Ok(())
    }
    fn join(&mut self) -> Result<()> {
        if self.thread.is_none() {
            return Ok(());
        }
        match self.thread.take() {
            Some(thread) => match thread.join() {
                Ok(_) => {
                    self.thread = None;
                    Ok(())
                }
                Err(_) => bail!("Cannot join dyn-timeout"),
            },
            None => bail!("Cannot take thread"),
        }
    }
}

impl Drop for DynTimeout {
    fn drop(&mut self) {
        self.join().unwrap()
    }
}