1 /*
2  * Copyright (C) 2006 Apple Computer, 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25 
26 #ifndef SharedTimer_h
27 #define SharedTimer_h
28 
29 #include <wtf/FastAllocBase.h>
30 #include <wtf/Noncopyable.h>
31 
32 namespace WebCore {
33 
34     // Each thread has its own single instance of shared timer, which implements this interface.
35     // This instance is shared by all timers in the thread.
36     // Not intended to be used directly; use the Timer class instead.
37     class SharedTimer {
38         WTF_MAKE_NONCOPYABLE(SharedTimer); WTF_MAKE_FAST_ALLOCATED;
39     public:
SharedTimer()40         SharedTimer() { }
~SharedTimer()41         virtual ~SharedTimer() {}
42         virtual void setFiredFunction(void (*)()) = 0;
43 
44         // The fire time is relative to the classic POSIX epoch of January 1, 1970,
45         // as the result of currentTime() is.
46         virtual void setFireTime(double) = 0;
47         virtual void stop() = 0;
48     };
49 
50 
51     // Implemented by port (since it provides the run loop for the main thread).
52     // FIXME: make ports implement MainThreadSharedTimer directly instead.
53     void setSharedTimerFiredFunction(void (*)());
54     void setSharedTimerFireTime(double);
55     void stopSharedTimer();
56 
57     // Implementation of SharedTimer for the main thread.
58     class MainThreadSharedTimer : public SharedTimer {
59     public:
setFiredFunction(void (* function)())60         virtual void setFiredFunction(void (*function)())
61         {
62             setSharedTimerFiredFunction(function);
63         }
64 
setFireTime(double fireTime)65         virtual void setFireTime(double fireTime)
66         {
67             setSharedTimerFireTime(fireTime);
68         }
69 
stop()70         virtual void stop()
71         {
72             stopSharedTimer();
73         }
74     };
75 
76 } // namespace WebCore
77 
78 #endif // SharedTimer_h
79