Out-of-process plug-ins should support asynchronous initialization
[WebKit-https.git] / Source / WebKit2 / PluginProcess / WebProcessConnection.h
1 /*
2  * Copyright (C) 2010 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 #ifndef WebProcessConnection_h
27 #define WebProcessConnection_h
28
29 #if ENABLE(PLUGIN_PROCESS)
30
31 #include "Connection.h"
32 #include "Plugin.h"
33 #include <wtf/HashSet.h>
34 #include <wtf/RefCounted.h>
35
36 namespace WebKit {
37
38 class NPRemoteObjectMap;
39 class PluginControllerProxy;
40 struct PluginCreationParameters;
41     
42 // A connection from a plug-in process to a web process.
43
44 class WebProcessConnection : public RefCounted<WebProcessConnection>, CoreIPC::Connection::Client {
45 public:
46     static PassRefPtr<WebProcessConnection> create(CoreIPC::Connection::Identifier);
47     virtual ~WebProcessConnection();
48
49     CoreIPC::Connection* connection() const { return m_connection.get(); }
50     NPRemoteObjectMap* npRemoteObjectMap() const { return m_npRemoteObjectMap.get(); }
51
52     void removePluginControllerProxy(PluginControllerProxy*, Plugin*);
53
54     static void setGlobalException(const String&);
55
56 private:
57     WebProcessConnection(CoreIPC::Connection::Identifier);
58
59     void addPluginControllerProxy(PassOwnPtr<PluginControllerProxy>);
60
61     void destroyPluginControllerProxy(PluginControllerProxy*);
62
63     // CoreIPC::Connection::Client
64     virtual void didReceiveMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder*);
65     virtual void didReceiveSyncMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder*, OwnPtr<CoreIPC::ArgumentEncoder>&);
66     virtual void didClose(CoreIPC::Connection*);
67     virtual void didReceiveInvalidMessage(CoreIPC::Connection*, CoreIPC::MessageID);
68     virtual void syncMessageSendTimedOut(CoreIPC::Connection*);
69
70     // Message handlers.
71     void didReceiveWebProcessConnectionMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder*);
72     void didReceiveSyncWebProcessConnectionMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder*, OwnPtr<CoreIPC::ArgumentEncoder>&);
73     void createPlugin(const PluginCreationParameters&, bool& result, bool& wantsWheelEvents, uint32_t& remoteLayerClientID);
74     void createPluginAsynchronously(const PluginCreationParameters&);
75     void destroyPlugin(uint64_t pluginInstanceID, bool asynchronousCreationIncomplete);
76     
77     void createPluginInternal(const PluginCreationParameters&, bool& result, bool& wantsWheelEvents, uint32_t& remoteLayerClientID);
78
79     RefPtr<CoreIPC::Connection> m_connection;
80
81     HashMap<uint64_t, PluginControllerProxy*> m_pluginControllers;
82     RefPtr<NPRemoteObjectMap> m_npRemoteObjectMap;
83     HashSet<uint64_t> m_asynchronousInstanceIDsToIgnore;
84 };
85
86 } // namespace WebKit
87
88 #endif // ENABLE(PLUGIN_PROCESS)
89
90
91 #endif // WebProcessConnection_h