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/Noncopyable.h>
30
31namespace WebCore {
32
33    // Each thread has its own single instance of shared timer, which implements this interface.
34    // This instance is shared by all timers in the thread.
35    // Not intended to be used directly; use the Timer class instead.
36    class SharedTimer : public Noncopyable {
37    public:
38        virtual ~SharedTimer() {}
39        virtual void setFiredFunction(void (*)()) = 0;
40
41        // The fire time is relative to the classic POSIX epoch of January 1, 1970,
42        // as the result of currentTime() is.
43        virtual void setFireTime(double) = 0;
44        virtual void stop() = 0;
45    };
46
47
48    // Implemented by port (since it provides the run loop for the main thread).
49    // FIXME: make ports implement MainThreadSharedTimer directly instead.
50    void setSharedTimerFiredFunction(void (*)());
51    void setSharedTimerFireTime(double);
52    void stopSharedTimer();
53
54    // Implementation of SharedTimer for the main thread.
55    class MainThreadSharedTimer : public SharedTimer {
56    public:
57        virtual void setFiredFunction(void (*function)())
58        {
59            setSharedTimerFiredFunction(function);
60        }
61
62        virtual void setFireTime(double fireTime)
63        {
64            setSharedTimerFireTime(fireTime);
65        }
66
67        virtual void stop()
68        {
69            stopSharedTimer();
70        }
71    };
72
73} // namespace WebCore
74
75#endif // SharedTimer_h
76