timer-0.2.0/Cargo.toml.orig01006440000765000002400000001014131555367410013745 0ustar0000000000000000[package] name = "timer" version = "0.2.0" authors = ["David Teller "] description = "A simple timer. Use it to schedule execution of closures after a delay or at a given timestamp." documentation = "http://yoric.github.io/timer.rs/doc/timer/" homepage = "https://github.com/Yoric/timer.rs" readme = "README.md" keywords = ["timer", "alarm", "schedule", "chrono", "chronometer"] license = "MPL-2.0" exclude = [ "publish-doc.sh", ".gitignore", ".travis.yml", ] [dependencies] chrono = "^0.4" timer-0.2.0/Cargo.toml0000644000000020170007170 0ustar00# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g. crates.io) dependencies # # If you believe there's an error in this file please file an # issue against the rust-lang/cargo repository. If you're # editing this file be aware that the upstream Cargo.toml # will likely look very different (and much more reasonable) [package] name = "timer" version = "0.2.0" authors = ["David Teller "] exclude = ["publish-doc.sh", ".gitignore", ".travis.yml"] description = "A simple timer. Use it to schedule execution of closures after a delay or at a given timestamp." homepage = "https://github.com/Yoric/timer.rs" documentation = "http://yoric.github.io/timer.rs/doc/timer/" readme = "README.md" keywords = ["timer", "alarm", "schedule", "chrono", "chronometer"] license = "MPL-2.0" [dependencies.chrono] version = "^0.4" timer-0.2.0/LICENSE01006440000765000002400000040525126676557210012104 0ustar0000000000000000Mozilla Public License Version 2.0 ================================== 1. Definitions -------------- 1.1. "Contributor" means each individual or legal entity that creates, contributes to the creation of, or owns Covered Software. 1.2. "Contributor Version" means the combination of the Contributions of others (if any) used by a Contributor and that particular Contributor's Contribution. 1.3. "Contribution" means Covered Software of a particular Contributor. 1.4. "Covered Software" means Source Code Form to which the initial Contributor has attached the notice in Exhibit A, the Executable Form of such Source Code Form, and Modifications of such Source Code Form, in each case including portions thereof. 1.5. "Incompatible With Secondary Licenses" means (a) that the initial Contributor has attached the notice described in Exhibit B to the Covered Software; or (b) that the Covered Software was made available under the terms of version 1.1 or earlier of the License, but not also under the terms of a Secondary License. 1.6. "Executable Form" means any form of the work other than Source Code Form. 1.7. "Larger Work" means a work that combines Covered Software with other material, in a separate file or files, that is not Covered Software. 1.8. "License" means this document. 1.9. "Licensable" means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently, any and all of the rights conveyed by this License. 1.10. "Modifications" means any of the following: (a) any file in Source Code Form that results from an addition to, deletion from, or modification of the contents of Covered Software; or (b) any new file in Source Code Form that contains any Covered Software. 1.11. "Patent Claims" of a Contributor means any patent claim(s), including without limitation, method, process, and apparatus claims, in any patent Licensable by such Contributor that would be infringed, but for the grant of the License, by the making, using, selling, offering for sale, having made, import, or transfer of either its Contributions or its Contributor Version. 1.12. "Secondary License" means either the GNU General Public License, Version 2.0, the GNU Lesser General Public License, Version 2.1, the GNU Affero General Public License, Version 3.0, or any later versions of those licenses. 1.13. "Source Code Form" means the form of the work preferred for making modifications. 1.14. "You" (or "Your") means an individual or a legal entity exercising rights under this License. For legal entities, "You" includes any entity that controls, is controlled by, or is under common control with You. For purposes of this definition, "control" means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity. 2. License Grants and Conditions -------------------------------- 2.1. Grants Each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license: (a) under intellectual property rights (other than patent or trademark) Licensable by such Contributor to use, reproduce, make available, modify, display, perform, distribute, and otherwise exploit its Contributions, either on an unmodified basis, with Modifications, or as part of a Larger Work; and (b) under Patent Claims of such Contributor to make, use, sell, offer for sale, have made, import, and otherwise transfer either its Contributions or its Contributor Version. 2.2. Effective Date The licenses granted in Section 2.1 with respect to any Contribution become effective for each Contribution on the date the Contributor first distributes such Contribution. 2.3. Limitations on Grant Scope The licenses granted in this Section 2 are the only rights granted under this License. No additional rights or licenses will be implied from the distribution or licensing of Covered Software under this License. Notwithstanding Section 2.1(b) above, no patent license is granted by a Contributor: (a) for any code that a Contributor has removed from Covered Software; or (b) for infringements caused by: (i) Your and any other third party's modifications of Covered Software, or (ii) the combination of its Contributions with other software (except as part of its Contributor Version); or (c) under Patent Claims infringed by Covered Software in the absence of its Contributions. This License does not grant any rights in the trademarks, service marks, or logos of any Contributor (except as may be necessary to comply with the notice requirements in Section 3.4). 2.4. Subsequent Licenses No Contributor makes additional grants as a result of Your choice to distribute the Covered Software under a subsequent version of this License (see Section 10.2) or under the terms of a Secondary License (if permitted under the terms of Section 3.3). 2.5. Representation Each Contributor represents that the Contributor believes its Contributions are its original creation(s) or it has sufficient rights to grant the rights to its Contributions conveyed by this License. 2.6. Fair Use This License is not intended to limit any rights You have under applicable copyright doctrines of fair use, fair dealing, or other equivalents. 2.7. Conditions Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in Section 2.1. 3. Responsibilities ------------------- 3.1. Distribution of Source Form All distribution of Covered Software in Source Code Form, including any Modifications that You create or to which You contribute, must be under the terms of this License. You must inform recipients that the Source Code Form of the Covered Software is governed by the terms of this License, and how they can obtain a copy of this License. You may not attempt to alter or restrict the recipients' rights in the Source Code Form. 3.2. Distribution of Executable Form If You distribute Covered Software in Executable Form then: (a) such Covered Software must also be made available in Source Code Form, as described in Section 3.1, and You must inform recipients of the Executable Form how they can obtain a copy of such Source Code Form by reasonable means in a timely manner, at a charge no more than the cost of distribution to the recipient; and (b) You may distribute such Executable Form under the terms of this License, or sublicense it under different terms, provided that the license for the Executable Form does not attempt to limit or alter the recipients' rights in the Source Code Form under this License. 3.3. Distribution of a Larger Work You may create and distribute a Larger Work under terms of Your choice, provided that You also comply with the requirements of this License for the Covered Software. If the Larger Work is a combination of Covered Software with a work governed by one or more Secondary Licenses, and the Covered Software is not Incompatible With Secondary Licenses, this License permits You to additionally distribute such Covered Software under the terms of such Secondary License(s), so that the recipient of the Larger Work may, at their option, further distribute the Covered Software under the terms of either this License or such Secondary License(s). 3.4. Notices You may not remove or alter the substance of any license notices (including copyright notices, patent notices, disclaimers of warranty, or limitations of liability) contained within the Source Code Form of the Covered Software, except that You may alter any license notices to the extent required to remedy known factual inaccuracies. 3.5. Application of Additional Terms You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, You may do so only on Your own behalf, and not on behalf of any Contributor. You must make it absolutely clear that any such warranty, support, indemnity, or liability obligation is offered by You alone, and You hereby agree to indemnify every Contributor for any liability incurred by such Contributor as a result of warranty, support, indemnity or liability terms You offer. You may include additional disclaimers of warranty and limitations of liability specific to any jurisdiction. 4. Inability to Comply Due to Statute or Regulation --------------------------------------------------- If it is impossible for You to comply with any of the terms of this License with respect to some or all of the Covered Software due to statute, judicial order, or regulation then You must: (a) comply with the terms of this License to the maximum extent possible; and (b) describe the limitations and the code they affect. Such description must be placed in a text file included with all distributions of the Covered Software under this License. Except to the extent prohibited by statute or regulation, such description must be sufficiently detailed for a recipient of ordinary skill to be able to understand it. 5. Termination -------------- 5.1. The rights granted under this License will terminate automatically if You fail to comply with any of its terms. However, if You become compliant, then the rights granted under this License from a particular Contributor are reinstated (a) provisionally, unless and until such Contributor explicitly and finally terminates Your grants, and (b) on an ongoing basis, if such Contributor fails to notify You of the non-compliance by some reasonable means prior to 60 days after You have come back into compliance. Moreover, Your grants from a particular Contributor are reinstated on an ongoing basis if such Contributor notifies You of the non-compliance by some reasonable means, this is the first time You have received notice of non-compliance with this License from such Contributor, and You become compliant prior to 30 days after Your receipt of the notice. 5.2. If You initiate litigation against any entity by asserting a patent infringement claim (excluding declaratory judgment actions, counter-claims, and cross-claims) alleging that a Contributor Version directly or indirectly infringes any patent, then the rights granted to You by any and all Contributors for the Covered Software under Section 2.1 of this License shall terminate. 5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user license agreements (excluding distributors and resellers) which have been validly granted by You or Your distributors under this License prior to termination shall survive termination. ************************************************************************ * * * 6. Disclaimer of Warranty * * ------------------------- * * * * Covered Software is provided under this License on an "as is" * * basis, without warranty of any kind, either expressed, implied, or * * statutory, including, without limitation, warranties that the * * Covered Software is free of defects, merchantable, fit for a * * particular purpose or non-infringing. The entire risk as to the * * quality and performance of the Covered Software is with You. * * Should any Covered Software prove defective in any respect, You * * (not any Contributor) assume the cost of any necessary servicing, * * repair, or correction. This disclaimer of warranty constitutes an * * essential part of this License. No use of any Covered Software is * * authorized under this License except under this disclaimer. * * * ************************************************************************ ************************************************************************ * * * 7. Limitation of Liability * * -------------------------- * * * * Under no circumstances and under no legal theory, whether tort * * (including negligence), contract, or otherwise, shall any * * Contributor, or anyone who distributes Covered Software as * * permitted above, be liable to You for any direct, indirect, * * special, incidental, or consequential damages of any character * * including, without limitation, damages for lost profits, loss of * * goodwill, work stoppage, computer failure or malfunction, or any * * and all other commercial damages or losses, even if such party * * shall have been informed of the possibility of such damages. This * * limitation of liability shall not apply to liability for death or * * personal injury resulting from such party's negligence to the * * extent applicable law prohibits such limitation. Some * * jurisdictions do not allow the exclusion or limitation of * * incidental or consequential damages, so this exclusion and * * limitation may not apply to You. * * * ************************************************************************ 8. Litigation ------------- Any litigation relating to this License may be brought only in the courts of a jurisdiction where the defendant maintains its principal place of business and such litigation shall be governed by laws of that jurisdiction, without reference to its conflict-of-law provisions. Nothing in this Section shall prevent a party's ability to bring cross-claims or counter-claims. 9. Miscellaneous ---------------- This License represents the complete agreement concerning the subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not be used to construe this License against a Contributor. 10. Versions of the License --------------------------- 10.1. New Versions Mozilla Foundation is the license steward. Except as provided in Section 10.3, no one other than the license steward has the right to modify or publish new versions of this License. Each version will be given a distinguishing version number. 10.2. Effect of New Versions You may distribute the Covered Software under the terms of the version of the License under which You originally received the Covered Software, or under the terms of any subsequent version published by the license steward. 10.3. Modified Versions If you create software not governed by this License, and you want to create a new license for such software, you may create and use a modified version of this License if you rename the license and remove any references to the name of the license steward (except to note that such modified license differs from this License). 10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses If You choose to distribute Source Code Form that is Incompatible With Secondary Licenses under the terms of this version of the License, the notice described in Exhibit B of this License must be attached. Exhibit A - Source Code Form License Notice ------------------------------------------- This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice. You may add additional accurate notices of copyright ownership. Exhibit B - "Incompatible With Secondary Licenses" Notice --------------------------------------------------------- This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0. timer-0.2.0/README.md01006440000765000002400000000767126655472570012364 0ustar0000000000000000# Timer [![Build Status](https://api.travis-ci.org/Yoric/timer.rs.svg?branch=master)](https://travis-ci.org/Yoric/timer.rs) Simple implementation of a Timer in and for Rust. # Example ```rust extern crate timer; extern crate chrono; use std::sync::mpsc::channel; let timer = timer::Timer::new(); let (tx, rx) = channel(); timer.schedule_with_delay(chrono::Duration::seconds(3), move || { tx.send(()).unwrap(); }); rx.recv().unwrap(); println!("This code has been executed after 3 seconds"); ``` timer-0.2.0/src/lib.rs01006440000765000002400000067125131555357150013000 0ustar0000000000000000//! A simple timer, used to enqueue operations meant to be executed at //! a given time or after a given delay. extern crate chrono; use std::cmp::Ordering; use std::thread; use std::sync::atomic::AtomicBool; use std::sync::atomic::Ordering as AtomicOrdering; use std::sync::{Arc, Mutex, Condvar}; use std::sync::mpsc::{channel, Sender}; use std::collections::BinaryHeap; use chrono::{Duration, DateTime}; use chrono::offset::Utc; /// An item scheduled for delayed execution. struct Schedule { /// The instant at which to execute. date: DateTime, /// The schedule data. data : T, /// A mechanism to cancel execution of an item. guard: Guard, /// If `Some(d)`, the item must be repeated every interval of /// length `d`, until cancelled. repeat: Option } impl Ord for Schedule { fn cmp(&self, other: &Self) -> Ordering { self.date.cmp(&other.date).reverse() } } impl PartialOrd for Schedule { fn partial_cmp(&self, other: &Self) -> Option { self.date.partial_cmp(&other.date).map(|ord| ord.reverse()) } } impl Eq for Schedule { } impl PartialEq for Schedule { fn eq(&self, other: &Self) -> bool { self.date.eq(&other.date) } } /// An operation to be sent across threads. enum Op { /// Schedule a new item for execution. Schedule(Schedule), /// Stop the thread. Stop } /// A mutex-based kind-of-channel used to communicate between the /// Communication thread and the Scheuler thread. struct WaiterChannel { /// Pending messages. messages: Mutex>>, /// A condition variable used for waiting. condvar: Condvar, } impl WaiterChannel { fn with_capacity(cap: usize) -> Self { WaiterChannel { messages: Mutex::new(Vec::with_capacity(cap)), condvar: Condvar::new(), } } } /// A trait that allows configurable execution of scheduled item /// on the scheduler thread. trait Executor { // Due to difference in use between Box and most other data // types, this trait requires implementors to provide two implementations // of execute. While both of these functions execute the data item // they differ on whether they make an equivalent data item available // to the Scheduler to store in recurring schedules. // // execute() is called whenever a non-recurring data item needs // to be executed, and consumes the data item in the process. // // execute_clone() is called whenever a recurring data item needs // to be executed, and produces a new equivalent data item. This // function should be more or less equivalent to: // // fn execute_clone(&mut self, data : T) -> T { // self.execute(data.clone()); // data // } fn execute(&mut self, data : T); fn execute_clone(&mut self, data : T) -> T; } /// An executor implementation for executing callbacks on the scheduler /// thread. struct CallbackExecutor; impl Executor> for CallbackExecutor { fn execute(&mut self, mut data : Box) { data(); } fn execute_clone(&mut self, mut data : Box) -> Box { data(); data } } /// An executor implementation for delivering messages to a channel. struct DeliveryExecutor where T : 'static + Send { /// The channel to deliver messages to. tx : Sender } impl Executor for DeliveryExecutor where T : 'static + Send + Clone { fn execute(&mut self, data : T) { let _ = self.tx.send(data); } fn execute_clone(&mut self, data : T) -> T { let _ = self.tx.send(data.clone()); data } } struct Scheduler where E : Executor { waiter: Arc>, heap: BinaryHeap>, executor: E } impl Scheduler where E : Executor { fn with_capacity(waiter: Arc>, executor : E, capacity: usize) -> Self { Scheduler { waiter: waiter, executor: executor, heap: BinaryHeap::with_capacity(capacity), } } fn run(&mut self) { enum Sleep { NotAtAll, UntilAwakened, AtMost(Duration) } let ref waiter = *self.waiter; loop { let mut lock = waiter.messages.lock().unwrap(); // Pop all messages. for msg in lock.drain(..) { match msg { Op::Stop => { return; } Op::Schedule(sched) => self.heap.push(sched), } } // Pop all the callbacks that are ready. // If we don't find let mut sleep = Sleep::UntilAwakened; loop { let now = Utc::now(); if let Some(sched) = self.heap.peek() { if sched.date > now { // First item is not ready yet, so we need to // wait until it is or something happens. sleep = Sleep::AtMost(sched.date.signed_duration_since(now)); break; } } else { // Schedule is empty, nothing to do, wait until something happens. break; } // At this stage, we have an item that has reached // execution time. The `unwrap()` is guaranteed to // succeed. let sched = self.heap.pop().unwrap(); if !sched.guard.should_execute() { // Execution has been cancelled, skip this item. continue; } if let Some(delta) = sched.repeat { let data = self.executor.execute_clone(sched.data); // This is a repeating timer, so we need to // enqueue the next call. sleep = Sleep::NotAtAll; self.heap.push(Schedule { date: sched.date + delta, data: data, guard: sched.guard, repeat: Some(delta) }); } else { self.executor.execute(sched.data); } } match sleep { Sleep::UntilAwakened => { let _ = waiter.condvar.wait(lock); }, Sleep::AtMost(delay) => { let sec = delay.num_seconds(); let ns = (delay - Duration::seconds(sec)).num_nanoseconds().unwrap(); // This `unwrap()` asserts that the number of ns is not > 1_000_000_000. Since we just substracted the number of seconds, the assertion should always pass. let duration = std::time::Duration::new(sec as u64, ns as u32); let _ = waiter.condvar.wait_timeout(lock, duration); }, Sleep::NotAtAll => {} } } } } /// Shared coordination logic for timer threads. pub struct TimerBase where T : 'static + Send { /// Sender used to communicate with the _Communication_ thread. In /// turn, this thread will send tx: Sender>, } impl Drop for TimerBase where T : 'static + Send { /// Stop the timer threads. fn drop(&mut self) { self.tx.send(Op::Stop).unwrap(); } } impl TimerBase where T : 'static + Send { /// Create a timer base. /// /// This immediatey launches two threads, which will remain /// launched until the timer is dropped. As expected, the threads /// spend most of their life waiting for instructions. fn new(executor : E) -> Self where E : 'static + Executor + Send { Self::with_capacity(executor, 32) } /// As `new()`, but with a manually specified initial capaicty. fn with_capacity(executor : E, capacity: usize) -> Self where E : 'static + Executor + Send { let waiter_send = Arc::new(WaiterChannel::with_capacity(capacity)); let waiter_recv = waiter_send.clone(); // Spawn a first thread, whose sole role is to dispatch // messages to the second thread without having to wait too // long for the mutex. let (tx, rx) = channel(); thread::spawn(move || { use Op::*; let ref waiter = *waiter_send; for msg in rx.iter() { let mut vec = waiter.messages.lock().unwrap(); match msg { Schedule(sched) => { vec.push(Schedule(sched)); waiter.condvar.notify_one(); } Stop => { vec.clear(); vec.push(Op::Stop); waiter.condvar.notify_one(); return; } } } }); // Spawn a second thread, in charge of scheduling. thread::Builder::new().name("Timer thread".to_owned()).spawn(move || { let mut scheduler = Scheduler::with_capacity(waiter_recv, executor, capacity); scheduler.run() }).unwrap(); TimerBase { tx: tx } } pub fn schedule_with_delay(&self, delay: Duration, data : T) -> Guard { self.schedule_with_date(Utc::now() + delay, data) } pub fn schedule_with_date(&self, date: DateTime, data : T) -> Guard where D : chrono::offset::TimeZone { self.schedule(date, None, data) } pub fn schedule_repeating(&self, repeat: Duration, data : T) -> Guard { self.schedule(Utc::now() + repeat, Some(repeat), data) } pub fn schedule(&self, date: DateTime, repeat: Option, data : T) -> Guard where D : chrono::offset::TimeZone { let guard = Guard::new(); self.tx.send(Op::Schedule(Schedule { date: date.with_timezone(&Utc), data: data, guard: guard.clone(), repeat: repeat })).unwrap(); guard } } /// A timer, used to schedule execution of callbacks at a later date. /// /// In the current implementation, each timer is executed as two /// threads. The _Scheduler_ thread is in charge of maintaining the /// queue of callbacks to execute and of actually executing them. The /// _Communication_ thread is in charge of communicating with the /// _Scheduler_ thread (which requires acquiring a possibly-long-held /// Mutex) without blocking the caller thread. pub struct Timer { base: TimerBase> } impl Timer { /// Create a timer. /// /// This immediatey launches two threads, which will remain /// launched until the timer is dropped. As expected, the threads /// spend most of their life waiting for instructions. pub fn new() -> Self { Timer { base : TimerBase::new(CallbackExecutor) } } /// As `new()`, but with a manually specified initial capaicty. pub fn with_capacity(capacity: usize) -> Self { Timer { base : TimerBase::with_capacity(CallbackExecutor, capacity) } } /// Schedule a callback for execution after a delay. /// /// Callbacks are guaranteed to never be called before the /// delay. However, it is possible that they will be called a /// little after the delay. /// /// If the delay is negative or 0, the callback is executed as /// soon as possible. /// /// This method returns a `Guard` object. If that `Guard` is /// dropped, execution is cancelled. /// /// # Performance /// /// The callback is executed on the Scheduler thread. It should /// therefore terminate very quickly, or risk causing delaying /// other callbacks. /// /// # Failures /// /// Any failure in `cb` will scheduler thread and progressively /// contaminate the Timer and the calling thread itself. You have /// been warned. /// /// # Example /// /// ``` /// extern crate timer; /// extern crate chrono; /// use std::sync::mpsc::channel; /// /// let timer = timer::Timer::new(); /// let (tx, rx) = channel(); /// /// let _guard = timer.schedule_with_delay(chrono::Duration::seconds(3), move || { /// // This closure is executed on the scheduler thread, /// // so we want to move it away asap. /// /// let _ignored = tx.send(()); // Avoid unwrapping here. /// }); /// /// rx.recv().unwrap(); /// println!("This code has been executed after 3 seconds"); /// ``` pub fn schedule_with_delay(&self, delay: Duration, cb: F) -> Guard where F: 'static + FnMut() + Send { self.base.schedule_with_delay(delay, Box::new(cb)) } /// Schedule a callback for execution at a given date. /// /// Callbacks are guaranteed to never be called before their /// date. However, it is possible that they will be called a /// little after it. /// /// If the date is in the past, the callback is executed as soon /// as possible. /// /// This method returns a `Guard` object. If that `Guard` is /// dropped, execution is cancelled. /// /// /// # Performance /// /// The callback is executed on the Scheduler thread. It should /// therefore terminate very quickly, or risk causing delaying /// other callbacks. /// /// # Failures /// /// Any failure in `cb` will scheduler thread and progressively /// contaminate the Timer and the calling thread itself. You have /// been warned. pub fn schedule_with_date(&self, date: DateTime, cb: F) -> Guard where F: 'static + FnMut() + Send, T : chrono::offset::TimeZone { self.base.schedule_with_date(date, Box::new(cb)) } /// Schedule a callback for execution once per interval. /// /// Callbacks are guaranteed to never be called before their /// date. However, it is possible that they will be called a /// little after it. /// /// This method returns a `Guard` object. If that `Guard` is /// dropped, repeat is stopped. /// /// /// # Performance /// /// The callback is executed on the Scheduler thread. It should /// therefore terminate very quickly, or risk causing delaying /// other callbacks. /// /// # Failures /// /// Any failure in `cb` will scheduler thread and progressively /// contaminate the Timer and the calling thread itself. You have /// been warned. /// /// # Example /// /// ``` /// extern crate timer; /// extern crate chrono; /// use std::thread; /// use std::sync::{Arc, Mutex}; /// /// let timer = timer::Timer::new(); /// // Number of times the callback has been called. /// let count = Arc::new(Mutex::new(0)); /// /// // Start repeating. Each callback increases `count`. /// let guard = { /// let count = count.clone(); /// timer.schedule_repeating(chrono::Duration::milliseconds(5), move || { /// *count.lock().unwrap() += 1; /// }) /// }; /// /// // Sleep one second. The callback should be called ~200 times. /// thread::sleep(std::time::Duration::new(1, 0)); /// let count_result = *count.lock().unwrap(); /// assert!(190 <= count_result && count_result <= 210, /// "The timer was called {} times", count_result); /// /// // Now drop the guard. This should stop the timer. /// drop(guard); /// thread::sleep(std::time::Duration::new(0, 100)); /// /// // Let's check that the count stops increasing. /// let count_start = *count.lock().unwrap(); /// thread::sleep(std::time::Duration::new(1, 0)); /// let count_stop = *count.lock().unwrap(); /// assert_eq!(count_start, count_stop); /// ``` pub fn schedule_repeating(&self, repeat: Duration, cb: F) -> Guard where F: 'static + FnMut() + Send { self.base.schedule_repeating(repeat, Box::new(cb)) } /// Schedule a callback for execution at a given time, then once /// per interval. A typical use case is to execute code once per /// day at 12am. /// /// Callbacks are guaranteed to never be called before their /// date. However, it is possible that they will be called a /// little after it. /// /// This method returns a `Guard` object. If that `Guard` is /// dropped, repeat is stopped. /// /// /// # Performance /// /// The callback is executed on the Scheduler thread. It should /// therefore terminate very quickly, or risk causing delaying /// other callbacks. /// /// # Failures /// /// Any failure in `cb` will scheduler thread and progressively /// contaminate the Timer and the calling thread itself. You have /// been warned. pub fn schedule(&self, date: DateTime, repeat: Option, cb: F) -> Guard where F: 'static + FnMut() + Send, T : chrono::offset::TimeZone { self.base.schedule(date, repeat, Box::new(cb)) } } /// A timer, used to schedule delivery of messages at a later date. /// /// In the current implementation, each timer is executed as two /// threads. The _Scheduler_ thread is in charge of maintaining the /// queue of messages to deliver and of actually deliverying them. The /// _Communication_ thread is in charge of communicating with the /// _Scheduler_ thread (which requires acquiring a possibly-long-held /// Mutex) without blocking the caller thread. /// /// Similar functionality could be implemented using the generic Timer /// type, however, using MessageTimer has two performance advantages /// over doing so. First, MessageTimer does not need to heap allocate /// a closure for each scheduled item, since the messages to queue are /// passed directly. Second, MessageTimer avoids the dynamic dispatch /// overhead associated with invoking the closure functions. pub struct MessageTimer where T : 'static + Send + Clone { base: TimerBase } impl MessageTimer where T : 'static + Send + Clone { /// Create a message timer. /// /// This immediatey launches two threads, which will remain /// launched until the timer is dropped. As expected, the threads /// spend most of their life waiting for instructions. pub fn new(tx: Sender) -> Self { MessageTimer { base : TimerBase::new(DeliveryExecutor { tx : tx }) } } /// As `new()`, but with a manually specified initial capaicty. pub fn with_capacity(tx: Sender, capacity: usize) -> Self { MessageTimer { base : TimerBase::with_capacity(DeliveryExecutor { tx : tx }, capacity) } } /// Schedule a message for delivery after a delay. /// /// Messages are guaranteed to never be delivered before the /// delay. However, it is possible that they will be delivered a /// little after the delay. /// /// If the delay is negative or 0, the message is delivered as /// soon as possible. /// /// This method returns a `Guard` object. If that `Guard` is /// dropped, delivery is cancelled. /// /// /// # Example /// /// ``` /// extern crate timer; /// extern crate chrono; /// use std::sync::mpsc::channel; /// /// let (tx, rx) = channel(); /// let timer = timer::MessageTimer::new(tx); /// let _guard = timer.schedule_with_delay(chrono::Duration::seconds(3), 3); /// /// rx.recv().unwrap(); /// println!("This code has been executed after 3 seconds"); /// ``` pub fn schedule_with_delay(&self, delay: Duration, msg : T) -> Guard { self.base.schedule_with_delay(delay, msg) } /// Schedule a message for delivery at a given date. /// /// Messages are guaranteed to never be delivered before their /// date. However, it is possible that they will be delivered a /// little after it. /// /// If the date is in the past, the message is delivered as soon /// as possible. /// /// This method returns a `Guard` object. If that `Guard` is /// dropped, delivery is cancelled. /// pub fn schedule_with_date(&self, date: DateTime, msg : T) -> Guard where D : chrono::offset::TimeZone { self.base.schedule_with_date(date, msg) } /// Schedule a message for delivery once per interval. /// /// Messages are guaranteed to never be delivered before their /// date. However, it is possible that they will be delivered a /// little after it. /// /// This method returns a `Guard` object. If that `Guard` is /// dropped, repeat is stopped. /// /// /// # Performance /// /// The message is cloned on the Scheduler thread. Cloning of /// messages should therefore succeed very quickly, or risk /// delaying other messages. /// /// # Failures /// /// Any failure in cloning of messages will occur on the scheduler thread /// and will contaminate the Timer and the calling thread itself. You have /// been warned. /// /// # Example /// /// ``` /// extern crate timer; /// extern crate chrono; /// use std::sync::mpsc::channel; /// /// let (tx, rx) = channel(); /// let timer = timer::MessageTimer::new(tx); /// /// // Start repeating. /// let guard = timer.schedule_repeating(chrono::Duration::milliseconds(5), 0); /// /// let mut count = 0; /// while count < 5 { /// let _ = rx.recv(); /// println!("Prints every 5 milliseconds"); /// count += 1; /// } /// ``` pub fn schedule_repeating(&self, repeat: Duration, msg : T) -> Guard { self.base.schedule_repeating(repeat, msg) } /// Schedule a message for delivery at a given time, then once /// per interval. A typical use case is to execute code once per /// day at 12am. /// /// Messages are guaranteed to never be delivered before their /// date. However, it is possible that they will be delivered a /// little after it. /// /// This method returns a `Guard` object. If that `Guard` is /// dropped, repeat is stopped. /// /// # Performance /// /// The message is cloned on the Scheduler thread. Cloning of /// messages should therefore succeed very quickly, or risk /// delaying other messages. /// /// # Failures /// /// Any failure in cloning of messages will occur on the scheduler thread /// and will contaminate the Timer and the calling thread itself. You have /// been warned. pub fn schedule(&self, date: DateTime, repeat: Option, msg : T) -> Guard where D : chrono::offset::TimeZone { self.base.schedule(date, repeat, msg) } } /// A value scoping a schedule. When this value is dropped, the /// schedule is cancelled. #[derive(Clone)] pub struct Guard { should_execute: Arc, ignore_drop: bool } impl Guard { fn new() -> Self { Guard { should_execute: Arc::new(AtomicBool::new(true)), ignore_drop: false } } fn should_execute(&self) -> bool { self.should_execute.load(AtomicOrdering::Relaxed) } /// Ignores the guard, preventing it from disabling the scheduled /// item. This can be used to avoid maintaining a Guard handle /// for items that will never be cancelled. pub fn ignore(mut self) { self.ignore_drop = true; } } impl Drop for Guard { /// Cancel a schedule. fn drop(&mut self) { if !self.ignore_drop { self.should_execute.store(false, AtomicOrdering::Relaxed) } } } #[cfg(test)] mod tests { extern crate std; use super::*; use std::sync::mpsc::channel; use std::sync::{Arc, Mutex}; use std::thread; use chrono::{Duration, Utc}; #[test] fn test_schedule_with_delay() { let timer = Timer::new(); let (tx, rx) = channel(); let mut guards = vec![]; // Schedule a number of callbacks in an arbitrary order, make sure // that they are executed in the right order. let mut delays = vec![1, 5, 3, -1]; let start = Utc::now(); for i in delays.clone() { println!("Scheduling for execution in {} seconds", i); let tx = tx.clone(); guards.push(timer.schedule_with_delay(Duration::seconds(i), move || { println!("Callback {}", i); tx.send(i).unwrap(); })); } delays.sort(); for (i, msg) in (0..delays.len()).zip(rx.iter()) { let elapsed = Utc::now().signed_duration_since(start).num_seconds(); println!("Received message {} after {} seconds", msg, elapsed); assert_eq!(msg, delays[i]); assert!(delays[i] <= elapsed && elapsed <= delays[i] + 3, "We have waited {} seconds, expecting [{}, {}]", elapsed, delays[i], delays[i] + 3); } // Now make sure that callbacks that are designed to be executed // immediately are executed quickly. let start = Utc::now(); for i in vec![10, 0] { println!("Scheduling for execution in {} seconds", i); let tx = tx.clone(); guards.push(timer.schedule_with_delay(Duration::seconds(i), move || { println!("Callback {}", i); tx.send(i).unwrap(); })); } assert_eq!(rx.recv().unwrap(), 0); assert!(Utc::now().signed_duration_since(start) <= Duration::seconds(1)); } #[test] fn test_message_timer() { let (tx, rx) = channel(); let timer = MessageTimer::new(tx); let start = Utc::now(); let mut delays = vec!(400, 300, 100, 500, 200); for delay in delays.clone() { timer.schedule_with_delay(Duration::milliseconds(delay), delay).ignore(); } delays.sort(); for delay in delays { assert_eq!(rx.recv().unwrap(), delay); } assert!(Utc::now().signed_duration_since(start) <= Duration::seconds(1)); } #[test] fn test_guards() { println!("Testing that callbacks aren't called if the guard is dropped"); let timer = Timer::new(); let called = Arc::new(Mutex::new(false)); for i in 0..10 { let called = called.clone(); timer.schedule_with_delay(Duration::milliseconds(i), move || { *called.lock().unwrap() = true; }); } thread::sleep(std::time::Duration::new(1, 0)); assert_eq!(*called.lock().unwrap(), false); } #[test] fn test_guard_ignore() { let timer = Timer::new(); let called = Arc::new(Mutex::new(false)); { let called = called.clone(); timer.schedule_with_delay(Duration::milliseconds(1), move || { *called.lock().unwrap() = true; }).ignore(); } thread::sleep(std::time::Duration::new(1, 0)); assert_eq!(*called.lock().unwrap(), true); } struct NoCloneMessage; impl Clone for NoCloneMessage { fn clone(&self) -> Self { panic!("TestMessage should not be cloned"); } } #[test] fn test_no_clone() { // Make sure that, if no schedule is supplied to a MessageTimer // the message instances are not cloned. let (tx, rx) = channel(); let timer = MessageTimer::new(tx); timer.schedule_with_delay(Duration::milliseconds(0), NoCloneMessage).ignore(); timer.schedule_with_delay(Duration::milliseconds(0), NoCloneMessage).ignore(); for _ in 0..2 { let _ = rx.recv(); } } }