Throttle DOM timers on hidden pages.
[WebKit-https.git] / Source / WebCore / page / SuspendableTimer.cpp
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 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 #include "config.h"
28 #include "SuspendableTimer.h"
29
30 #include "ScriptExecutionContext.h"
31
32 namespace WebCore {
33
34 SuspendableTimer::SuspendableTimer(ScriptExecutionContext* context)
35     : ActiveDOMObject(context, this)
36     , m_nextFireInterval(0)
37     , m_repeatInterval(0)
38     , m_active(false)
39 #if !ASSERT_DISABLED
40     , m_suspended(false)
41 #endif
42 {
43 }
44
45 SuspendableTimer::~SuspendableTimer()
46 {
47 }
48
49 bool SuspendableTimer::hasPendingActivity() const
50 {
51     return isActive();
52 }
53
54 void SuspendableTimer::stop()
55 {
56     TimerBase::stop();
57 }
58
59 void SuspendableTimer::suspend(ReasonForSuspension)
60 {
61 #if !ASSERT_DISABLED
62     ASSERT(!m_suspended);
63     m_suspended = true;
64 #endif
65     m_active = isActive();
66     if (m_active) {
67         m_nextFireInterval = nextUnalignedFireInterval();
68         m_repeatInterval = repeatInterval();
69         TimerBase::stop();
70     }
71 }
72
73 void SuspendableTimer::resume()
74 {
75 #if !ASSERT_DISABLED
76     ASSERT(m_suspended);
77     m_suspended = false;
78 #endif
79     if (m_active)
80         start(m_nextFireInterval, m_repeatInterval);
81 }
82
83 bool SuspendableTimer::canSuspend() const
84 {
85     return true;
86 }
87
88 } // namespace WebCore