diff options
author | MarcoFalke <falke.marco@gmail.com> | 2020-03-06 18:06:50 -0500 |
---|---|---|
committer | MarcoFalke <falke.marco@gmail.com> | 2020-03-10 09:47:32 -0400 |
commit | fadafb83cff9a9a340eac1b5a853e2467d5e0ef7 (patch) | |
tree | 62583dfe70fc70cfde198ca12c1872ef79adc5a6 /src/scheduler.h | |
parent | fa70ccc6c4e304646b4610228f3975b3a9762643 (diff) |
scheduler: Make schedule* methods type safe
Diffstat (limited to 'src/scheduler.h')
-rw-r--r-- | src/scheduler.h | 24 |
1 files changed, 14 insertions, 10 deletions
diff --git a/src/scheduler.h b/src/scheduler.h index 71d1726c4f..1e64195484 100644 --- a/src/scheduler.h +++ b/src/scheduler.h @@ -24,8 +24,8 @@ // Usage: // // CScheduler* s = new CScheduler(); -// s->scheduleFromNow(doSomething, 11); // Assuming a: void doSomething() { } -// s->scheduleFromNow(std::bind(Class::func, this, argument), 3); +// s->scheduleFromNow(doSomething, std::chrono::milliseconds{11}); // Assuming a: void doSomething() { } +// s->scheduleFromNow([=] { this->func(argument); }, std::chrono::milliseconds{3}); // boost::thread* t = new boost::thread(std::bind(CScheduler::serviceQueue, s)); // // ... then at program shutdown, make sure to call stop() to clean up the thread(s) running serviceQueue: @@ -46,15 +46,19 @@ public: // Call func at/after time t void schedule(Function f, std::chrono::system_clock::time_point t); - // Convenience method: call f once deltaMilliSeconds from now - void scheduleFromNow(Function f, int64_t deltaMilliSeconds); + /** Call f once after the delta has passed */ + void scheduleFromNow(Function f, std::chrono::milliseconds delta) + { + schedule(std::move(f), std::chrono::system_clock::now() + delta); + } - // Another convenience method: call f approximately - // every deltaMilliSeconds forever, starting deltaMilliSeconds from now. - // To be more precise: every time f is finished, it - // is rescheduled to run deltaMilliSeconds later. If you - // need more accurate scheduling, don't use this method. - void scheduleEvery(Function f, int64_t deltaMilliSeconds); + /** + * Repeat f until the scheduler is stopped. First run is after delta has passed once. + * + * The timing is not exact: Every time f is finished, it is rescheduled to run again after delta. If you need more + * accurate scheduling, don't use this method. + */ + void scheduleEvery(Function f, std::chrono::milliseconds delta); /** * Mock the scheduler to fast forward in time. |