1 | /* |
2 | * Copyright (C) 2008, 2013 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 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 | #pragma once |
28 | |
29 | #include "ActiveDOMObject.h" |
30 | #include "Timer.h" |
31 | |
32 | #include <wtf/Seconds.h> |
33 | |
34 | namespace WebCore { |
35 | |
36 | class SuspendableTimer : private TimerBase, public ActiveDOMObject { |
37 | public: |
38 | explicit SuspendableTimer(ScriptExecutionContext&); |
39 | virtual ~SuspendableTimer(); |
40 | |
41 | // A hook for derived classes to perform cleanup. |
42 | virtual void didStop(); |
43 | |
44 | // Part of TimerBase interface used by SuspendableTimer clients, modified to work when suspended. |
45 | bool isActive() const { return TimerBase::isActive() || (m_suspended && m_savedIsActive); } |
46 | bool isSuspended() const { return m_suspended; } |
47 | |
48 | Seconds repeatInterval() const; |
49 | |
50 | void startRepeating(Seconds repeatInterval); |
51 | void startOneShot(Seconds interval); |
52 | |
53 | void augmentFireInterval(Seconds delta); |
54 | void augmentRepeatInterval(Seconds delta); |
55 | |
56 | using TimerBase::didChangeAlignmentInterval; |
57 | using TimerBase::operator new; |
58 | using TimerBase::operator delete; |
59 | |
60 | void cancel(); // Equivalent to TimerBase::stop(), whose name conflicts with ActiveDOMObject::stop(). |
61 | |
62 | private: |
63 | void fired() override = 0; |
64 | |
65 | // ActiveDOMObject API. |
66 | bool hasPendingActivity() const final; |
67 | void stop() final; |
68 | bool canSuspendForDocumentSuspension() const final; |
69 | void suspend(ReasonForSuspension) final; |
70 | void resume() final; |
71 | |
72 | Seconds m_savedNextFireInterval; |
73 | Seconds m_savedRepeatInterval; |
74 | |
75 | bool m_suspended { false }; |
76 | bool m_savedIsActive { false }; |
77 | }; |
78 | |
79 | } // namespace WebCore |
80 | |