d8f94b4b33d2cecc7a4bc718a49621a4816019df
[WebKit-https.git] / Source / WTF / wtf / RunLoopTimer.h
1 /*
2  * Copyright (C) 2009 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef RunLoopTimer_h
30 #define RunLoopTimer_h
31
32 #include <wtf/SchedulePair.h>
33 #include <wtf/RetainPtr.h>
34
35 namespace WTF {
36
37 // Time intervals are all in seconds.
38
39 class WTF_EXPORT_PRIVATE RunLoopTimerBase {
40     WTF_MAKE_NONCOPYABLE(RunLoopTimerBase);
41 public:
42     RunLoopTimerBase() { }
43     WTF_EXPORT_PRIVATE virtual ~RunLoopTimerBase();
44
45     WTF_EXPORT_PRIVATE void schedule(const SchedulePair*);
46     WTF_EXPORT_PRIVATE void schedule(const SchedulePairHashSet&);
47
48     WTF_EXPORT_PRIVATE void start(double nextFireInterval, double repeatInterval);
49
50     void startRepeating(double repeatInterval) { start(repeatInterval, repeatInterval); }
51     void startOneShot(double interval) { start(interval, 0); }
52
53     WTF_EXPORT_PRIVATE void stop();
54     bool isActive() const;
55
56     virtual void fired() = 0;
57
58 private:
59 #if USE(CF)
60     RetainPtr<CFRunLoopTimerRef> m_timer;
61 #endif
62 };
63
64 template <typename TimerFiredClass> class RunLoopTimer : public RunLoopTimerBase {
65 public:
66     typedef void (TimerFiredClass::*TimerFiredFunction)(RunLoopTimer*);
67
68     RunLoopTimer(TimerFiredClass* o, TimerFiredFunction f)
69         : m_object(o), m_function(f) { }
70
71     virtual void fired() { (m_object->*m_function)(this); }
72
73 private:
74     TimerFiredClass* m_object;
75     TimerFiredFunction m_function;
76 };
77
78 } // namespace WTF
79
80 using WTF::RunLoopTimer;
81
82 #endif