bb0b48334c6b24cab36f8a8e4328f5e8b80186ea
[chaz/yoink] / src / Moof / Timer.hh
1
2 /*******************************************************************************
3
4 Copyright (c) 2009, Charles McGarvey
5 All rights reserved.
6
7 Redistribution and use in source and binary forms, with or without
8 modification, are permitted provided that the following conditions are met:
9
10 * Redistributions of source code must retain the above copyright notice,
11 this list of conditions and the following disclaimer.
12 * Redistributions in binary form must reproduce the above copyright notice,
13 this list of conditions and the following disclaimer in the documentation
14 and/or other materials provided with the distribution.
15
16 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
20 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
23 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26
27 *******************************************************************************/
28
29 #ifndef _MOOF_TIMER_HH_
30 #define _MOOF_TIMER_HH_
31
32 /**
33 * @file Timer.hh
34 * Functions for measuring time in a friendly unit.
35 */
36
37 #include <map>
38
39 #include <boost/bind.hpp>
40 #include <boost/function.hpp>
41
42 #include <Moof/Math.hh>
43
44
45 namespace Mf {
46
47
48 class Timer
49 {
50 public:
51
52 enum Mode
53 {
54 INVALID = -1,
55 NORMAL = 0,
56 ABSOLUTEE = 1, // the ABSOLUTE keyword isn't available on win32...
57 REPEAT = 2
58 };
59
60 typedef boost::function<void(Timer&,Scalar)> Function;
61
62
63 Timer() :
64 mMode(INVALID) {}
65
66 Timer(const Function& function, Scalar seconds, Mode mode = NORMAL)
67 {
68 init(function, seconds, mode);
69 }
70
71 ~Timer()
72 {
73 invalidate();
74 }
75
76 void init(const Function& function, Scalar seconds, Mode mode = NORMAL);
77
78 bool isValid() const;
79 void invalidate();
80
81 void fire();
82
83 Scalar getSecondsRemaining() const;
84 bool isExpired() const;
85 bool isRepeating() const;
86
87
88 /**
89 * Get the number of seconds since a fixed, arbitrary point in the past.
90 * @return Seconds.
91 */
92
93 static Scalar getTicks();
94
95
96 /**
97 * Put the thread to sleep for a certain period of time. If absolute is true,
98 * then it will sleep until seconds after the fixed time in the past. If
99 * absolute is false, it will sleep for seconds starting now. Unlike system
100 * sleep functions, this one automatically resumes sleep if sleep was
101 * interrupted by a signal. Therefore, calling this function is guaranteed to
102 * sleep for the requested amount of time (and maybe longer).
103 */
104
105 static void sleep(Scalar seconds, bool absolute = false);
106
107
108 static Scalar getNextFire()
109 {
110 return gNextFire;
111 }
112
113 static void fireIfExpired(Scalar t);
114
115 private:
116
117 static unsigned getNewID();
118 static Scalar findNextFire();
119
120 Function mFunction;
121 Mode mMode;
122 Scalar mAbsolute;
123 Scalar mInterval;
124 unsigned mId;
125
126 static Scalar gNextFire;
127 static std::map<unsigned,Timer&> gTimers;
128 };
129
130
131 } // namespace Mf
132
133
134 #endif // _MOOF_TIMER_HH_
135
136 /** vim: set ts=4 sw=4 tw=80: *************************************************/
137
This page took 0.031856 seconds and 3 git commands to generate.