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

//! A simple thread pool library for Rust.
//!
//! # Examples
//!
//! Basic usage:
//!
//! ```
//! use std::sync::mpsc;
//! use std::thread;
//! use std::time::Duration;
//! use tasque::TaskQueueBuilder;
//!
//! // Creates a task queue.
//! // This queue spawns worker threads for executing tasks.
//! let queue = TaskQueueBuilder::new().worker_count(3).finish();
//!
//! // Executes asynchronous tasks.
//! let (tx, rx) = mpsc::channel();
//! for (i, tx) in (0..3).map(|i| (i, tx.clone())) {
//!     queue.enqueue(move || {
//!         thread::sleep(Duration::from_millis(20 - i * 10));
//!         let _ = tx.send(i);
//!     });
//! }
//!
//! // Waits results.
//! assert_eq!(rx.recv().ok(), Some(2));
//! assert_eq!(rx.recv().ok(), Some(1));
//! assert_eq!(rx.recv().ok(), Some(0));
//! ```
#![warn(missing_docs)]
extern crate num_cpus;
extern crate prometrics;

pub use queue::{TaskQueue, TaskQueueBuilder};

pub mod metrics;

mod queue;
mod task;
mod worker;

#[cfg(test)]
mod tests {
    use std::sync::mpsc;
    use std::thread;
    use std::time::Duration;
    use super::*;

    #[test]
    fn single_worker_works() {
        let (tx, rx) = mpsc::channel();
        let queue = TaskQueueBuilder::new().worker_count(1).finish();
        for (i, tx) in (0..3).map(|i| (i, tx.clone())) {
            queue.enqueue(move || {
                thread::sleep(Duration::from_millis(30 - i * 10));
                let _ = tx.send(i);
            });
        }
        assert_eq!(queue.len(), 3);
        assert_eq!(rx.recv().ok(), Some(0));

        assert_eq!(queue.len(), 2);
        assert_eq!(rx.recv().ok(), Some(1));

        assert_eq!(queue.len(), 1);
        assert_eq!(rx.recv().ok(), Some(2));

        assert_eq!(queue.len(), 0);
        assert_eq!(queue.worker_count(), 1);
    }

    #[test]
    fn multiple_workers_works() {
        let (tx, rx) = mpsc::channel();
        let queue = TaskQueueBuilder::new().worker_count(3).finish();
        for (i, tx) in (0..3).map(|i| (i, tx.clone())) {
            queue.enqueue(move || {
                thread::sleep(Duration::from_millis(20 - i * 10));
                let _ = tx.send(i);
            });
        }
        assert_eq!(queue.len(), 3);
        assert_eq!(rx.recv().ok(), Some(2));
        assert_eq!(rx.recv().ok(), Some(1));
        assert_eq!(rx.recv().ok(), Some(0));
        assert_eq!(queue.len(), 0);
        assert_eq!(queue.worker_count(), 3);
    }

    #[test]
    fn worker_restart_works() {
        let (tx, rx) = mpsc::channel();
        let queue = TaskQueueBuilder::new().worker_count(1).finish();
        queue.enqueue(|| panic!());
        thread::sleep(Duration::from_millis(1));
        queue.enqueue(move || tx.send(0).unwrap());
        assert_eq!(rx.recv().ok(), Some(0));
        assert_eq!(queue.len(), 0);
    }
}