summaryrefslogtreecommitdiff
path: root/lib/common/Timer.cpp
blob: e05affb26885df4337bae9400ee16a2b528f4a63 (plain)
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
// --------------------------------------------------------------------------
//
// File
//		Name:    Timer.cpp
//		Purpose: Generic timers which execute arbitrary code when
//			 they expire.
//		Created: 5/11/2006
//
// --------------------------------------------------------------------------

#include "Box.h"

#include <signal.h>

#include "Timer.h"

#include "MemLeakFindOn.h"

std::vector<Timer*> Timers::sTimers;
bool Timers::sInitialised = false;

// --------------------------------------------------------------------------
//
// Function
//		Name:    static void TimerSigHandler(int)
//		Purpose: Signal handler, notifies Timers class
//		Created: 19/3/04
//
// --------------------------------------------------------------------------
static void TimerSigHandler(int iUnused)
{
	Timers::Signal();	
}

// --------------------------------------------------------------------------
//
// Function
//		Name:    static void Timers::Init()
//		Purpose: Initialise timers, prepare signal handler
//		Created: 5/11/2006
//
// --------------------------------------------------------------------------
void Timers::Init()
{
	ASSERT(!sInitialised);
	
	#ifdef PLATFORM_CYGWIN
		ASSERT(::signal(SIGALRM, TimerSigHandler) == 0);
	#elif defined WIN32
		// no support for signals at all
		InitTimer();
		SetTimerHandler(TimerSigHandler);
	#else
		ASSERT(::signal(SIGALRM, TimerSigHandler) == 0);
	#endif // PLATFORM_CYGWIN
	
	sInitialised = true;
}

// --------------------------------------------------------------------------
//
// Function
//		Name:    static void Timers::Cleanup()
//		Purpose: Clean up timers, stop signal handler
//		Created: 6/11/2006
//
// --------------------------------------------------------------------------
void Timers::Cleanup()
{
	ASSERT(sInitialised);
	
	#ifdef PLATFORM_CYGWIN
		ASSERT(::signal(SIGALRM, NULL) == TimerSigHandler);
	#elif defined WIN32
		// no support for signals at all
		SetTimerHandler(NULL);
		FiniTimer();
	#else
		ASSERT(::signal(SIGALRM, NULL) == TimerSigHandler);
	#endif // PLATFORM_CYGWIN

	sTimers.clear();
	
	sInitialised = false;
}

// --------------------------------------------------------------------------
//
// Function
//		Name:    static void Timers::Add(Timer&)
//		Purpose: Add a new timer to the set, and reschedule next wakeup
//		Created: 5/11/2006
//
// --------------------------------------------------------------------------
void Timers::Add(Timer& rTimer)
{
	ASSERT(sInitialised);
	sTimers.push_back(&rTimer);
	Reschedule();
}

// --------------------------------------------------------------------------
//
// Function
//		Name:    static void Timers::Remove(Timer&)
//		Purpose: Removes the timer from the set (preventing it from
//			 being called) and reschedule next wakeup
//		Created: 5/11/2006
//
// --------------------------------------------------------------------------
void Timers::Remove(Timer& rTimer)
{
	ASSERT(sInitialised);

	bool restart = true;
	while (restart)
	{
		restart = false;
		for (std::vector<Timer*>::iterator i = sTimers.begin();
			i != sTimers.end(); i++)
		{
			if (&rTimer == *i)
			{
				sTimers.erase(i);
				restart = true;
				break;
			}
		}
	}
		
	Reschedule();
}

// --------------------------------------------------------------------------
//
// Function
//		Name:    static void Timers::Reschedule()
//		Purpose: Recalculate when the next wakeup is due
//		Created: 5/11/2006
//
// --------------------------------------------------------------------------
void Timers::Reschedule()
{
	ASSERT(sInitialised);

	box_time_t timeNow = GetCurrentBoxTime();
	box_time_t timeToNextEvent = 0;
	
	for (std::vector<Timer*>::iterator i = sTimers.begin();
		i != sTimers.end(); i++)
	{
		Timer& rTimer = **i;
		ASSERT(!rTimer.HasExpired());
		
		box_time_t timeToExpiry = rTimer.GetExpiryTime() - timeNow;
		
		if (timeToNextEvent == 0 || timeToNextEvent > timeToExpiry)
		{
			timeToNextEvent = timeToExpiry;
		}
	}
	
	ASSERT(timeToNextEvent >= 0);
	
	struct itimerval timeout;
	memset(&timeout, 0, sizeof(timeout));
	
	timeout.it_value.tv_sec  = BoxTimeToSeconds(timeToNextEvent);
	timeout.it_value.tv_usec = (int)
		(BoxTimeToMicroSeconds(timeToNextEvent) % MICRO_SEC_IN_SEC);

#ifdef PLATFORM_CYGWIN
	if(::setitimer(ITIMER_REAL, &timeout, NULL) != 0)
#else
	if(::setitimer(ITIMER_REAL, &timeout, NULL) != 0)
#endif // PLATFORM_CYGWIN
	{
		TRACE0("WARNING: couldn't initialise timer\n");
		THROW_EXCEPTION(CommonException, Internal)
	}
}

// --------------------------------------------------------------------------
//
// Function
//		Name:    static void Timers::Signal()
//		Purpose: Called by signal handler. Signals any timers which
//			 are due or overdue, removes them from the set,
//			 and reschedules next wakeup.
//		Created: 5/11/2006
//
// --------------------------------------------------------------------------
void Timers::Signal()
{
	ASSERT(sInitialised);

	box_time_t timeNow = GetCurrentBoxTime();

	std::vector<Timer*> timersCopy = sTimers;
	
	for (std::vector<Timer*>::iterator i = timersCopy.begin();
		i != timersCopy.end(); i++)
	{
		Timer& rTimer = **i;
		ASSERT(!rTimer.HasExpired());
		
		box_time_t timeToExpiry = rTimer.GetExpiryTime() - timeNow;
		
		if (timeToExpiry <= 0)
		{
			rTimer.OnExpire();
		}
	}		
		
	Reschedule();
}

Timer::Timer(size_t timeoutSecs)
: mExpires(GetCurrentBoxTime() + SecondsToBoxTime(timeoutSecs)),
  mExpired(false)
{
	Timers::Add(*this);
}

Timer::~Timer()
{
	Timers::Remove(*this);
}

Timer::Timer(const Timer& rToCopy)
: mExpires(rToCopy.mExpires),
  mExpired(rToCopy.mExpired)
{
	Timers::Add(*this);
}

Timer& Timer::operator=(const Timer& rToCopy)
{
	Timers::Remove(*this);
	mExpires = rToCopy.mExpires;
	mExpired = rToCopy.mExpired;
	if (!mExpired)
	{
		Timers::Add(*this);
	}
}

void Timer::OnExpire()
{
	mExpired = true;
	Timers::Remove(*this);
}