/usr/include/gnelib/Timer.h is in libgnelib-dev 0.75+svn20091130-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 | #ifndef TIMER_H_INCLUDED_C517B9FE
#define TIMER_H_INCLUDED_C517B9FE
/* GNE - Game Networking Engine, a portable multithreaded networking library.
* Copyright (C) 2001-2006 Jason Winnebeck
* Project website: http://www.gillius.org/gne/
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#include <gnelib/Thread.h>
#include <gnelib/Time.h>
#include <gnelib/Mutex.h>
#include <gnelib/SmartPtr.h>
#include <gnelib/WeakPtr.h>
namespace GNE {
class TimerCallback;
/**
* @ingroup threading
*
* The timer class is used to get the current time and to provide callbacks.
* A timer object calls its listeners back every so often based on the time
* given.
*
* All of the methods in this class are safe to call from multiple threads at
* the same time, and can also be called from the TimerCallback as well, with
* a few (some obvious) exceptions.
*
* A Timer thread runs with a higher priority than the main thread, therefore
* its callbacks are suitable for short, quick tasks.
*/
class Timer : public Thread {
protected:
Timer(const SmartPtr<TimerCallback>& callback, int rate);
public:
typedef SmartPtr<Timer> sptr;
typedef WeakPtr<Timer> wptr;
/**
* Stops all Timers.
*/
static void stopAll();
/**
* Create a timer callback. The first call to the callback will occur
* after "rate" milliseconds, so this class is suitable for setting
* timeouts for your operations. Use the startTimer method to start this
* timer.
*
* The callback is released when the Timer is stopped. This allows the
* callback to contain a reference to the Timer.
*
* @param callback A newly allocated object to perform callbacks on.
* @param rate the callback rate in milliseconds.
*/
static sptr create(const SmartPtr<TimerCallback>& callback, int rate);
/**
* Destructor.
*/
virtual ~Timer();
/**
* Returns the current time from some arbitrary point in the past. This is
* usually a very high precision timer that likely provides microsecond
* or better resolution.
*/
static Time getCurrentTime();
/**
* Returns the current time from the system clock.
*
* The time returned is an absolute time, relative to midnight,
* Jan 1, 1970.
*/
static Time getAbsoluteTime();
/**
* Returns the TimerCallback set in the constructor. After the timer has
* stopped, an empty SmartPtr is returned since the listener is released
* when the timer stops.
*/
SmartPtr<TimerCallback> getCallback() const;
/**
* Starts the timer running and calling the callback. If the timer has
* already started, this call will have no effect. You cannot restart a
* Timer once you have stopped it, you need to create a new Timer.
*/
void startTimer();
/**
* Equivalent to calling stopTimer with false.
*/
virtual void shutDown();
/**
* Stops the timer and stops calling the callback. The timer will likely
* be called one more time because the timer will actually stop at the end
* of its most recent cycle. If you want to wait until the callback is
* called for the last time, pass true into this function. Then this
* function will block for at most the time of the callback rate plus the
* time it takes for the callback to finish.
*
* This timer's callback can call this function, but obviously it must not
* pass true to this function.
*
* If a Timer is already stopped, this function will have no effect.
*/
void stopTimer(bool waitForEnd);
protected:
/**
* This is the thread that will perform the callbacks.
*/
void run();
private:
/**
* Next time the callbacks will be activated.
*/
Time nextTime;
/**
* The callback rate in microseconds. This is different from the accepted
* parameter in the constructor of milliseconds.
*/
int callbackRate;
SmartPtr<TimerCallback> listener;
/**
* Provides synchronization for some functions to make them thread safe.
*/
mutable Mutex sync;
};
}
#endif /* TIMER_H_INCLUDED_C517B9FE */
|