Home | History | Annotate | Download | only in platform 
      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 "platform/PlatformExport.h"
     30 #include "wtf/FastAllocBase.h"
     31 #include "wtf/Noncopyable.h"
     32 
     33 namespace WebCore {
     34 
     35 // Each thread has its own single instance of shared timer, which implements this interface.
     36 // This instance is shared by all timers in the thread.
     37 // Not intended to be used directly; use the Timer class instead.
     38 class PLATFORM_EXPORT SharedTimer {
     39     WTF_MAKE_NONCOPYABLE(SharedTimer); WTF_MAKE_FAST_ALLOCATED;
     40 public:
     41     SharedTimer() { }
     42     virtual ~SharedTimer() {}
     43     virtual void setFiredFunction(void (*)()) = 0;
     44 
     45     // The fire interval is in seconds relative to the current monotonic clock time.
     46     virtual void setFireInterval(double) = 0;
     47     virtual void stop() = 0;
     48 };
     49 
     50 
     51 PLATFORM_EXPORT void setSharedTimerFiredFunction(void (*)());
     52 PLATFORM_EXPORT void setSharedTimerFireInterval(double);
     53 PLATFORM_EXPORT void stopSharedTimer();
     54 
     55 class PLATFORM_EXPORT MainThreadSharedTimer : public SharedTimer {
     56 public:
     57     virtual void setFiredFunction(void (*function)())
     58     {
     59         setSharedTimerFiredFunction(function);
     60     }
     61 
     62     virtual void setFireInterval(double interval)
     63     {
     64         setSharedTimerFireInterval(interval);
     65     }
     66 
     67     virtual void stop()
     68     {
     69         stopSharedTimer();
     70     }
     71 };
     72 
     73 } // namespace WebCore
     74 
     75 #endif // SharedTimer_h
     76