Add a setting for keeping around all processes and always reusing them per-origin.
[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
33 namespace WebKit {
34
35 class WebPageProxy;
36 class WebProcessProxy;
37
38 class SuspendedPageProxy : public RefCounted<SuspendedPageProxy> {
39 public:
40     static Ref<SuspendedPageProxy> create(WebPageProxy& page, WebProcessProxy& process, WebBackForwardListItem& item)
41     {
42         return adoptRef(*new SuspendedPageProxy(page, process, item));
43     }
44
45     virtual ~SuspendedPageProxy();
46
47     void didReceiveMessage(IPC::Connection&, IPC::Decoder&);
48
49     WebPageProxy& page() const { return m_page; }
50     WebProcessProxy* process() const { return m_process; }
51     WebBackForwardListItem& item() const { return m_backForwardListItem; }
52     const WebCore::SecurityOriginData& origin() const { return m_origin; }
53
54     bool finishedSuspending() const { return m_finishedSuspending; }
55
56     void webProcessDidClose(WebProcessProxy&);
57     void destroyWebPageInWebProcess();
58
59 #if !LOG_DISABLED
60     const char* loggingString() const;
61 #endif
62
63 private:
64     SuspendedPageProxy(WebPageProxy&, WebProcessProxy&, WebBackForwardListItem&);
65
66     void didFinishLoad();
67
68     WebPageProxy& m_page;
69     WebProcessProxy* m_process;
70     Ref<WebBackForwardListItem> m_backForwardListItem;
71     WebCore::SecurityOriginData m_origin;
72
73     bool m_finishedSuspending { false };
74 };
75
76 } // namespace WebKit