1/*
2 * Copyright (C) 2014-2019 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. AND ITS CONTRIBUTORS ``AS IS''
14 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23 * THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#pragma once
27
28#include <wtf/Function.h>
29#include <wtf/ProcessID.h>
30#include <wtf/WeakPtr.h>
31#include <wtf/text/WTFString.h>
32
33#if !OS(WINDOWS)
34#include <unistd.h>
35#endif
36
37#if PLATFORM(IOS_FAMILY)
38#include <wtf/RetainPtr.h>
39OBJC_CLASS BKSProcessAssertion;
40#endif
41
42namespace WebKit {
43
44enum class AssertionState {
45 Suspended,
46 Background,
47 UnboundedNetworking,
48 Foreground,
49};
50
51enum class AssertionReason {
52 Extension,
53 FinishTask,
54 FinishTaskUnbounded,
55 MediaPlayback,
56};
57
58class ProcessAssertion : public CanMakeWeakPtr<ProcessAssertion> {
59 WTF_MAKE_FAST_ALLOCATED;
60public:
61 class Client {
62 public:
63 virtual ~Client() { }
64 virtual void uiAssertionWillExpireImminently() = 0;
65 };
66
67 ProcessAssertion(ProcessID, const String& reason, AssertionState);
68 ProcessAssertion(ProcessID, const String& reason, AssertionState, AssertionReason);
69 virtual ~ProcessAssertion();
70
71 void setClient(Client& client) { m_client = &client; }
72 Client* client() { return m_client; }
73
74 AssertionState state() const { return m_assertionState; }
75 virtual void setState(AssertionState);
76
77#if PLATFORM(IOS_FAMILY)
78protected:
79 enum class Validity { No, Yes, Unset };
80 Validity validity() const { return m_validity; }
81
82 virtual void processAssertionWasInvalidated();
83#endif
84
85private:
86#if PLATFORM(IOS_FAMILY)
87 RetainPtr<BKSProcessAssertion> m_assertion;
88 Validity m_validity { Validity::Unset };
89#endif
90 AssertionState m_assertionState;
91 Client* m_client { nullptr };
92};
93
94#if PLATFORM(IOS_FAMILY)
95
96class ProcessAndUIAssertion final : public ProcessAssertion {
97public:
98 ProcessAndUIAssertion(ProcessID, const String& reason, AssertionState);
99 ~ProcessAndUIAssertion();
100
101 void setState(AssertionState) final;
102 void uiAssertionWillExpireImminently();
103
104private:
105 void processAssertionWasInvalidated() final;
106 void updateRunInBackgroundCount();
107
108 bool m_isHoldingBackgroundTask { false };
109};
110
111#else
112
113using ProcessAndUIAssertion = ProcessAssertion;
114
115#endif // PLATFORM(IOS_FAMILY)
116
117} // namespace WebKit
118