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(NETSCAPE_PLUGIN_API)
30
31#include "Connection.h"
32#include "Plugin.h"
33#include "WebProcessConnectionMessages.h"
34#include <wtf/HashSet.h>
35#include <wtf/RefCounted.h>
36
37namespace WebKit {
38
39class NPRemoteObjectMap;
40class PluginControllerProxy;
41struct PluginCreationParameters;
42
43// A connection from a plug-in process to a web process.
44
45class WebProcessConnection : public RefCounted<WebProcessConnection>, IPC::Connection::Client {
46public:
47    static PassRefPtr<WebProcessConnection> create(IPC::Connection::Identifier);
48    virtual ~WebProcessConnection();
49
50    IPC::Connection* connection() const { return m_connection.get(); }
51    NPRemoteObjectMap* npRemoteObjectMap() const { return m_npRemoteObjectMap.get(); }
52
53    void removePluginControllerProxy(PluginControllerProxy*, Plugin*);
54
55    static void setGlobalException(const String&);
56
57    void pluginDidBecomeVisible(unsigned pluginInstanceID);
58    void pluginDidBecomeHidden(unsigned pluginInstanceID);
59
60    void audioHardwareDidBecomeActive();
61    void audioHardwareDidBecomeInactive();
62
63private:
64    WebProcessConnection(IPC::Connection::Identifier);
65
66    void addPluginControllerProxy(std::unique_ptr<PluginControllerProxy>);
67
68    void destroyPluginControllerProxy(PluginControllerProxy*);
69
70    // IPC::Connection::Client
71    virtual void didReceiveMessage(IPC::Connection*, IPC::MessageDecoder&) override;
72    virtual void didReceiveSyncMessage(IPC::Connection*, IPC::MessageDecoder&, std::unique_ptr<IPC::MessageEncoder>&) override;
73    virtual void didClose(IPC::Connection*);
74    virtual void didReceiveInvalidMessage(IPC::Connection*, IPC::StringReference messageReceiverName, IPC::StringReference messageName);
75
76    // Message handlers.
77    void didReceiveWebProcessConnectionMessage(IPC::Connection*, IPC::MessageDecoder&);
78    void didReceiveSyncWebProcessConnectionMessage(IPC::Connection*, IPC::MessageDecoder&, std::unique_ptr<IPC::MessageEncoder>&);
79    void createPlugin(const PluginCreationParameters&, PassRefPtr<Messages::WebProcessConnection::CreatePlugin::DelayedReply>);
80    void createPluginAsynchronously(const PluginCreationParameters&);
81    void destroyPlugin(uint64_t pluginInstanceID, bool asynchronousCreationIncomplete, PassRefPtr<Messages::WebProcessConnection::DestroyPlugin::DelayedReply>);
82
83    void createPluginInternal(const PluginCreationParameters&, bool& result, bool& wantsWheelEvents, uint32_t& remoteLayerClientID);
84
85    RefPtr<IPC::Connection> m_connection;
86
87    HashMap<uint64_t, std::unique_ptr<PluginControllerProxy>> m_pluginControllers;
88    RefPtr<NPRemoteObjectMap> m_npRemoteObjectMap;
89    HashSet<uint64_t> m_asynchronousInstanceIDsToIgnore;
90    HashSet<uint64_t> m_visiblePluginInstanceIDs;
91};
92
93} // namespace WebKit
94
95#endif // ENABLE(NETSCAPE_PLUGIN_API)
96
97
98#endif // WebProcessConnection_h
99