]> git.tdb.fi Git - libs/core.git/blobdiff - source/time/timer.h
Move non-oneliner functions out of RefPtr class declaration
[libs/core.git] / source / time / timer.h
index 26ebf64a36d1725133934ef8fd9f282eca4da24d..62f248d23a722078472c461b9f04186c6cdd827d 100644 (file)
@@ -1,17 +1,12 @@
-/* $Id$
-
-This file is part of libmspcore     
-Copyright © 2006, 2009  Mikko Rasa, Mikkosoft Productions
-Distributed under the LGPL
-*/
-
 #ifndef MSP_TIME_TIMER_H_
 #define MSP_TIME_TIMER_H_
 
 #include <vector>
 #include <sigc++/sigc++.h>
-#include "../core/mutex.h"
-#include "../core/semaphore.h"
+#include <msp/core/attributes.h>
+#include <msp/core/mutex.h>
+#include <msp/core/noncopyable.h>
+#include <msp/core/semaphore.h>
 #include "timedelta.h"
 #include "timestamp.h"
 
@@ -25,7 +20,7 @@ of the returned slot.
 
 This class is thread-safe, to allow running timers in a separate thread.
 */
-class Timer
+class Timer: private NonCopyable
 {
 public:
        class Slot
@@ -56,36 +51,38 @@ private:
        std::vector<SlotProxy> slots;
        Semaphore sem;
        Mutex mutex;
+       bool blocking;
 
 public:
+       Timer();
        ~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,
-       waits until one times out.
+       /** Deprecated.  Use one of the other overloads. */
+       DEPRECATED void tick(bool block);
+
+       /** Waits until a timer expires, then executes it.  If no timers have been
+       set, blocks until one is added from another thread. */
+       void tick();
 
-       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.
-       */
-       void tick(bool block = true);
+       /** Waits until a timer expires but at most the specified amount of time.
+       If a timer did expire before the timeout, it is executed. */
+       void tick(const TimeDelta &);
 
+private:
+       void do_tick(const TimeDelta &);
+
+public:
        TimeStamp get_next_timeout() const;
 };