ScummVM API documentation
default-timer.h
1 /* ScummVM - Graphic Adventure Engine
2  *
3  * ScummVM is the legal property of its developers, whose names
4  * are too numerous to list here. Please refer to the COPYRIGHT
5  * file distributed with this source distribution.
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <http://www.gnu.org/licenses/>.
19  *
20  */
21 
22 #ifndef BACKENDS_TIMER_DEFAULT_H
23 #define BACKENDS_TIMER_DEFAULT_H
24 
25 #include "common/str.h"
26 #include "common/hash-str.h"
27 #include "common/timer.h"
28 #include "common/mutex.h"
29 
30 struct TimerSlot;
31 
33 private:
35 
36  Common::Mutex _mutex;
37  TimerSlot *_head;
38  TimerSlotMap _callbacks;
39 
40  uint32 _timerCallbackNext;
41 
42 public:
44  virtual ~DefaultTimerManager();
45  virtual bool installTimerProc(TimerProc proc, int32 interval, void *refCon, const Common::String &id);
46  virtual void removeTimerProc(TimerProc proc);
47 
51  void handler();
52 
53  /*
54  * Ensure that the callback is called at regular time intervals.
55  * Should be called from pollEvents() on backends without threads.
56  */
57  void checkTimers(uint32 interval = 10);
58 };
59 
60 #endif
Definition: str.h:59
Definition: default-timer.h:32
void(* TimerProc)(void *refCon)
Definition: timer.h:42
virtual bool installTimerProc(TimerProc proc, int32 interval, void *refCon, const Common::String &id)
Definition: timer.h:40
Definition: mutex.h:67
virtual void removeTimerProc(TimerProc proc)