-/* $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/mutex.h>
+#include <msp/core/semaphore.h>
#include "timedelta.h"
#include "timestamp.h"
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.
- */
- void tick(bool block=true);
+ won't return until a timer is added from another thread. */
+ void tick(bool block = true);
TimeStamp get_next_timeout() const;
};