X-Git-Url: http://git.tdb.fi/?p=libs%2Fcore.git;a=blobdiff_plain;f=source%2Ftime%2Ftimer.h;fp=source%2Ftime%2Ftimer.h;h=7566c3dd03a6a86eef6619c2d4ddd24ddbb373ca;hp=b080f82f8f3d3713e50dca5b995739f30143e81d;hb=1f0843257065789231a9949e0a81b79afd7bbebe;hpb=62a984b46e08740d19cb055f01be3365982f6b9d diff --git a/source/time/timer.h b/source/time/timer.h index b080f82..7566c3d 100644 --- a/source/time/timer.h +++ b/source/time/timer.h @@ -53,30 +53,22 @@ private: public: ~Timer(); - /** - Adds a timer that will be executed periodically as long as the timeout - signal hander returns true. - */ + /** Adds a timer that will be executed periodically as long as the timeout + signal hander returns true. */ Slot &add(const TimeDelta &); - /** - Adds a timer that will be executed once at a specific time. The return - value of the timeout signal handler is ignored. - */ + /** Adds a timer that will be executed once at a specific time. The return + value of the timeout signal handler is ignored. */ Slot &add(const TimeStamp &); - /** - Cancels a previously added timer. - */ + /** Cancels a previously added timer. */ void cancel(Slot &); - /** - Checks all timers, executing any that have timed out. If block is true, + /** Checks all timers, executing any that have timed out. If block is true, waits until one times out. Note: If there are no active timers when a blocking tick is executed, it - won't return until a timer is added from another thread. - */ + won't return until a timer is added from another thread. */ void tick(bool block = true); TimeStamp get_next_timeout() const;