WebCore/DOMTimer.h

   1 /*
   2  * Copyright (C) 2008 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  * 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
  27 #ifndef DOMTimer_h
  28 #define DOMTimer_h
  29
  30 #include "ActiveDOMObject.h"
  31 #include "Timer.h"
  32 #include <wtf/OwnPtr.h>
  33
  34 namespace WebCore {
  35
  36 class ScheduledAction;
  37
  38 class DOMTimer : public TimerBase, public ActiveDOMObject {
  39 public:
  40     virtual ~DOMTimer();
  41     // Creates a new timer owned by specified ScriptExecutionContext, starts it
  42     // and returns its Id.
  43     static int install(ScriptExecutionContext*, ScheduledAction*, int timeout, bool singleShot);
  44     static void removeById(ScriptExecutionContext*, int timeoutId);
  45
  46     // ActiveDOMObject
  47     virtual bool hasPendingActivity() const;
  48     virtual void contextDestroyed();
  49     virtual void stop();
  50     virtual bool canSuspend() const;
  51     virtual void suspend();
  52     virtual void resume();
  53
  54 private:
  55     DOMTimer(ScriptExecutionContext*, ScheduledAction*, int timeout, bool singleShot);
  56     virtual void fired();
  57
  58     int m_timeoutId;
  59     int m_nestingLevel;
  60     OwnPtr<ScheduledAction> m_action;
  61     double m_nextFireInterval;
  62     double m_repeatInterval;
  63 };
  64
  65 } // namespace WebCore
  66
  67 #endif // DOMTimer_h
  68