0d5585e0b7b8b0e46164a1c2816ee01cd5ac66dd
[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 "WebBackForwardListItem.h"
30 #include <WebCore/SecurityOriginData.h>
31 #include <wtf/RefCounted.h>
32 #include <wtf/WeakPtr.h>
33
34 namespace WebKit {
35
36 class WebPageProxy;
37 class WebProcessProxy;
38
39 class SuspendedPageProxy final: public IPC::MessageReceiver, public CanMakeWeakPtr<SuspendedPageProxy> {
40 public:
41     SuspendedPageProxy(WebPageProxy&, Ref<WebProcessProxy>&&, WebBackForwardListItem&, uint64_t mainFrameID);
42     ~SuspendedPageProxy();
43
44     WebPageProxy& page() const { return m_page; }
45     WebProcessProxy& process() { return m_process.get(); }
46     uint64_t mainFrameID() const { return m_mainFrameID; }
47     const WebCore::SecurityOriginData& origin() const { return m_origin; }
48
49     void tearDownDrawingAreaInWebProcess();
50
51     void unsuspend();
52
53 #if !LOG_DISABLED
54     const char* loggingString() const;
55 #endif
56
57 private:
58     void didFinishLoad();
59
60     // IPC::MessageReceiver
61     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) final;
62     void didReceiveSyncMessage(IPC::Connection&, IPC::Decoder&, std::unique_ptr<IPC::Encoder>&) final;
63
64     WebPageProxy& m_page;
65     Ref<WebProcessProxy> m_process;
66     uint64_t m_mainFrameID;
67     WebCore::SecurityOriginData m_origin;
68
69     bool m_isSuspended { true };
70
71 #if !LOG_DISABLED
72     bool m_finishedSuspending { false };
73 #endif
74 };
75
76 } // namespace WebKit