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