24cc68d2bb5ffbbf710bafe3b614fd37862e20e5
[WebKit-https.git] / Source / WebKit / UIProcess / SuspendedPageProxy.h
1 /*
2  * Copyright (C) 2018 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 "Connection.h"
29 #include "ProcessThrottler.h"
30 #include "WebBackForwardListItem.h"
31 #include "WebPageProxyMessages.h"
32 #include <WebCore/RegistrableDomain.h>
33 #include <wtf/RefCounted.h>
34 #include <wtf/WeakPtr.h>
35
36 namespace WebKit {
37
38 class WebPageProxy;
39 class WebProcessProxy;
40
41 class SuspendedPageProxy final: public IPC::MessageReceiver, public CanMakeWeakPtr<SuspendedPageProxy> {
42     WTF_MAKE_FAST_ALLOCATED;
43 public:
44     SuspendedPageProxy(WebPageProxy&, Ref<WebProcessProxy>&&, uint64_t mainFrameID);
45     ~SuspendedPageProxy();
46
47     WebPageProxy& page() const { return m_page; }
48     WebProcessProxy& process() { return m_process.get(); }
49     uint64_t mainFrameID() const { return m_mainFrameID; }
50
51     bool failedToSuspend() const { return m_suspensionState == SuspensionState::FailedToSuspend; }
52
53     void waitUntilReadyToUnsuspend(CompletionHandler<void(SuspendedPageProxy*)>&&);
54     void unsuspend();
55     void close();
56
57 #if !LOG_DISABLED
58     const char* loggingString() const;
59 #endif
60
61 private:
62     enum class SuspensionState : uint8_t { Suspending, FailedToSuspend, Suspended, Resumed };
63     void didProcessRequestToSuspend(SuspensionState);
64     void suspensionTimedOut();
65
66     // IPC::MessageReceiver
67     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) final;
68     void didReceiveSyncMessage(IPC::Connection&, IPC::Decoder&, std::unique_ptr<IPC::Encoder>&) final;
69
70     WebPageProxy& m_page;
71     Ref<WebProcessProxy> m_process;
72     uint64_t m_mainFrameID;
73     WebCore::RegistrableDomain m_registrableDomain;
74     bool m_isClosed { false };
75
76     SuspensionState m_suspensionState { SuspensionState::Suspending };
77     CompletionHandler<void(SuspendedPageProxy*)> m_readyToUnsuspendHandler;
78     RunLoop::Timer<SuspendedPageProxy> m_suspensionTimeoutTimer;
79 #if PLATFORM(IOS_FAMILY)
80     ProcessThrottler::BackgroundActivityToken m_suspensionToken;
81 #endif
82 };
83
84 } // namespace WebKit