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
use std::sync::Arc;
use std::sync::mpsc;
use std::thread;
use prometrics::metrics::MetricBuilder;
use num_cpus;

use metrics::Metrics;
use task::Task;
use worker::{Worker, WorkerHandle};

/// `TaskQueue` builder.
///
/// # Examples
///
/// ```
/// use tasque::TaskQueueBuilder;
///
/// let queue = TaskQueueBuilder::new().worker_count(4).finish();
/// queue.enqueue(|| println!("Hello"));
/// queue.enqueue(|| println!("World"));
/// ```
#[derive(Debug)]
pub struct TaskQueueBuilder {
    worker_count: usize,
    metrics: MetricBuilder,
}
impl TaskQueueBuilder {
    /// Makes a new `TaskQueueBuilder` instance.
    pub fn new() -> Self {
        TaskQueueBuilder {
            worker_count: num_cpus::get(),
            metrics: MetricBuilder::new(),
        }
    }

    /// Sets the number of worker threads which the queue to be built will spawn.
    pub fn worker_count(&mut self, count: usize) -> &mut Self {
        self.worker_count = count;
        self
    }

    /// Updates the settings of metrics using the given function.
    pub fn metrics<F>(&mut self, f: F) -> &mut Self
    where
        F: FnOnce(&mut MetricBuilder),
    {
        f(&mut self.metrics);
        self
    }

    /// Builds a `TaskQueue` instance.
    pub fn finish(&self) -> TaskQueue {
        let (task_tx, task_rx) = mpsc::channel();
        let (ctrl_tx, ctrl_rx) = mpsc::channel();
        let metrics = Arc::new(Metrics::new(self.metrics.clone()));
        let mut manager = TaskQueueManager {
            task_rx,
            ctrl_rx,
            ctrl_tx: ctrl_tx.clone(),
            generation: 0,
            metrics: Arc::clone(&metrics),
        };
        thread::spawn(move || while manager.run_once() {});
        let queue = TaskQueue {
            task_tx,
            ctrl_tx,
            metrics,
        };
        queue.set_worker_count(self.worker_count);
        queue
    }
}
impl Default for TaskQueueBuilder {
    fn default() -> Self {
        Self::new()
    }
}

/// Task queue.
///
/// This queue spawns worker threads for executing registered tasks.
///
/// # Examples
///
/// ```
/// use tasque::TaskQueue;
///
/// let queue = TaskQueue::new();
/// queue.enqueue(|| println!("Hello"));
/// queue.enqueue(|| println!("World"));
/// ```
#[derive(Debug, Clone)]
pub struct TaskQueue {
    task_tx: mpsc::Sender<Task>,
    ctrl_tx: mpsc::Sender<Control>,
    metrics: Arc<Metrics>,
}
impl TaskQueue {
    /// Makes a new `TaskQueue` instance.
    ///
    /// This is equivalent to `TaskQueueBuilder::new().finish()`.
    pub fn new() -> Self {
        TaskQueueBuilder::new().finish()
    }

    /// Enqueues a task.
    ///
    /// The task will be executed by a worker thread.
    ///
    /// If the thread panics while executing the task, it will be automatically restarted.
    /// Note that the task will not be retried in such case.
    pub fn enqueue<F>(&self, task: F)
    where
        F: FnOnce() + Send + 'static,
    {
        let _ = self.task_tx.send(Task::new(task, self.ctrl_tx.clone()));
        self.metrics.enqueued_tasks.increment();
    }

    /// Updates the number of worker threads of this queue.
    pub fn set_worker_count(&self, count: usize) {
        let ctrl = Control::SetWorkerCount(count);
        let _ = self.ctrl_tx.send(ctrl);
    }
}
impl Default for TaskQueue {
    fn default() -> Self {
        Self::new()
    }
}

#[derive(Debug)]
struct TaskQueueManager {
    task_rx: mpsc::Receiver<Task>,
    ctrl_rx: mpsc::Receiver<Control>,
    ctrl_tx: mpsc::Sender<Control>,
    generation: usize,
    metrics: Arc<Metrics>,
}
impl TaskQueueManager {
    fn run_once(&mut self) -> bool {
        match self.ctrl_rx.recv().expect("Never fails") {
            Control::SetWorkerCount(count) => {
                self.generation += 1;
                for _ in 0..count {
                    let worker = Worker::start(self.generation, Arc::clone(&self.metrics));
                    let _ = self.ctrl_tx.send(Control::PutToPool(worker));
                }
                self.metrics.workers.set(count as f64);
            }
            Control::PutToPool(worker) => {
                if worker.generation() != self.generation {
                    return true;
                }
                if let Ok(task) = self.task_rx.recv() {
                    self.metrics.dequeued_tasks.increment();
                    if let Err(task) = worker.try_execute(task) {
                        let worker = Worker::start(self.generation, Arc::clone(&self.metrics));
                        worker.try_execute(task).expect("Never fails");
                        self.metrics.worker_restarts.increment();
                    }
                } else {
                    return false;
                }
            }
        }
        true
    }
}

#[derive(Debug)]
pub enum Control {
    SetWorkerCount(usize),
    PutToPool(WorkerHandle),
}