Class Poco::Util::Timer

File Information

Library: Util
Package: Timer
Header: Poco/Util/Timer.h

Description

A Timer allows to schedule tasks (TimerTask objects) for future execution in a background thread. Tasks may be scheduled for one-time execution, or for repeated execution at regular intervals.

The Timer object creates a thread that executes all scheduled tasks sequentially. Therefore, tasks should complete their work as quickly as possible, otherwise subsequent tasks may be delayed.

Timer is safe for multithreaded use - multiple threads can schedule new tasks simultaneously.

Via the func() helper function template, a functor or lambda can be used as timer task:

timer.schedule(Timer::func([]()
    {
        std::cout << "Timer!\n";
    }),
    Poco::Clock());

Acknowledgement: The interface of this class has been inspired by the java.util.Timer class from Java 1.3.

Inheritance

Direct Base Classes: Poco::Runnable

All Base Classes: Poco::Runnable

Member Summary

Member Functions: cancel, func, idle, run, schedule, scheduleAtFixedRate, validateTask

Inherited Functions: run

Constructors

Timer

explicit Timer(
Poco::Thread::Priority priority
);

Creates the Timer, using a timer thread with the given priority.

Destructor

~Timer

~Timer();

Destroys the Timer, cancelling all pending tasks.

Member Functions

cancel

void cancel(
bool wait = false
);

Cancels all pending tasks.

If a task is currently running, it is allowed to finish.

Task cancellation is done asynchronously. If wait is false, cancel() returns immediately and the task queue will be purged as soon as the currently running task finishes. If wait is true, waits until the queue has been purged.

func

template < typename Fn > static TimerTask::Ptr func(
const Fn & fn
);

Helper function template to use a functor or lambda with Timer::schedule() and Timer::scheduleAtFixedRate().

func

template < typename Fn > static TimerTask::Ptr func(
Fn && fn
);

Helper function template to use a functor or lambda with Timer::schedule() and Timer::scheduleAtFixedRate().

idle

bool idle() const;

Returns true if the task queue is empty, otherwise false.

schedule

void schedule(
TimerTask::Ptr pTask,
Poco::Timestamp time
);

Schedules a task for execution at the specified time.

If the time lies in the past, the task is executed immediately.

Note: the relative time the task will be executed won't change if the system's time changes. If the given time is 10 seconds in the future at the point schedule() is called, the task will be executed 10 seconds later, even if the system time changes in between.

schedule

void schedule(
TimerTask::Ptr pTask,
Poco::Clock clock
);

Schedules a task for execution at the specified time.

If the time lies in the past, the task is executed immediately.

schedule

void schedule(
    TimerTask::Ptr pTask,
    long delay,
    long interval
);

Schedules a task for periodic execution.

The task is first executed after the given delay. Subsequently, the task is executed periodically with the given interval in milliseconds between invocations.

schedule

void schedule(
    TimerTask::Ptr pTask,
    Poco::Timestamp time,
    long interval
);

Schedules a task for periodic execution.

The task is first executed at the given time. Subsequently, the task is executed periodically with the given interval in milliseconds between invocations.

schedule

void schedule(
    TimerTask::Ptr pTask,
    Poco::Clock clock,
    long interval
);

Schedules a task for periodic execution.

The task is first executed at the given time. Subsequently, the task is executed periodically with the given interval in milliseconds between invocations.

scheduleAtFixedRate

void scheduleAtFixedRate(
    TimerTask::Ptr pTask,
    long delay,
    long interval
);

Schedules a task for periodic execution at a fixed rate.

The task is first executed after the given delay. Subsequently, the task is executed periodically every number of milliseconds specified by interval.

If task execution takes longer than the given interval, further executions are delayed.

scheduleAtFixedRate

void scheduleAtFixedRate(
    TimerTask::Ptr pTask,
    Poco::Timestamp time,
    long interval
);

Schedules a task for periodic execution at a fixed rate.

The task is first executed at the given time. Subsequently, the task is executed periodically every number of milliseconds specified by interval.

If task execution takes longer than the given interval, further executions are delayed.

Note: the relative time the task will be executed won't change if the system's time changes. If the given time is 10 seconds in the future at the point scheduleAtFixedRate() is called, the task will be executed 10 seconds later, even if the system time changes in between.

scheduleAtFixedRate

void scheduleAtFixedRate(
    TimerTask::Ptr pTask,
    Poco::Clock clock,
    long interval
);

Schedules a task for periodic execution at a fixed rate.

The task is first executed at the given time. Subsequently, the task is executed periodically every number of milliseconds specified by interval.

If task execution takes longer than the given interval, further executions are delayed.

run

void run();

See also: Poco::Runnable::run()

validateTask

static void validateTask(
const TimerTask::Ptr & pTask
);