Introduce SuspendedPageProxy to keep old web processes around after their WebPageProx...
[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 <wtf/RefCounted.h>
31
32 namespace WebKit {
33
34 class WebPageProxy;
35 class WebProcessProxy;
36
37 class SuspendedPageProxy : public RefCounted<SuspendedPageProxy> {
38 public:
39     static Ref<SuspendedPageProxy> create(WebPageProxy& page, WebProcessProxy& process, WebBackForwardListItem& item)
40     {
41         return adoptRef(*new SuspendedPageProxy(page, process, item));
42     }
43
44     virtual ~SuspendedPageProxy();
45
46     void didReceiveMessage(IPC::Connection&, IPC::Decoder&);
47
48     WebPageProxy& page() const { return m_page; }
49     WebProcessProxy* process() const { return m_process; }
50     WebBackForwardListItem& item() const { return m_backForwardListItem; }
51
52     bool finishedSuspending() const { return m_finishedSuspending; }
53
54     void webProcessDidClose(WebProcessProxy&);
55
56 #if !LOG_DISABLED
57     const char* loggingString() const;
58 #endif
59
60 private:
61     SuspendedPageProxy(WebPageProxy&, WebProcessProxy&, WebBackForwardListItem&);
62
63     void didFinishLoad();
64
65     WebPageProxy& m_page;
66     WebProcessProxy* m_process;
67     Ref<WebBackForwardListItem> m_backForwardListItem;
68
69     bool m_finishedSuspending { false };
70 };
71
72 } // namespace WebKit