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 PluginProcessConnection_h
27#define PluginProcessConnection_h
28
29#if ENABLE(PLUGIN_PROCESS)
30
31#include "Connection.h"
32#include "Plugin.h"
33#include "PluginProcess.h"
34#include "PluginProcessAttributes.h"
35#include <wtf/RefCounted.h>
36
37// A CoreIPC connection to a plug-in process.
38
39namespace WebKit {
40
41class NPRemoteObjectMap;
42class PluginProcessConnectionManager;
43class PluginProxy;
44
45class PluginProcessConnection : public RefCounted<PluginProcessConnection>, CoreIPC::Connection::Client {
46public:
47    static PassRefPtr<PluginProcessConnection> create(PluginProcessConnectionManager* pluginProcessConnectionManager, uint64_t pluginProcessToken, CoreIPC::Connection::Identifier connectionIdentifier, bool supportsAsynchronousPluginInitialization)
48    {
49        return adoptRef(new PluginProcessConnection(pluginProcessConnectionManager, pluginProcessToken, connectionIdentifier, supportsAsynchronousPluginInitialization));
50    }
51    ~PluginProcessConnection();
52
53    uint64_t pluginProcessToken() const { return m_pluginProcessToken; }
54
55    CoreIPC::Connection* connection() const { return m_connection.get(); }
56
57    void addPluginProxy(PluginProxy*);
58    void removePluginProxy(PluginProxy*);
59
60    NPRemoteObjectMap* npRemoteObjectMap() const { return m_npRemoteObjectMap.get(); }
61
62    bool supportsAsynchronousPluginInitialization() const { return m_supportsAsynchronousPluginInitialization; }
63
64private:
65    PluginProcessConnection(PluginProcessConnectionManager*, uint64_t pluginProcessToken, CoreIPC::Connection::Identifier connectionIdentifier, bool supportsAsynchronousInitialization);
66
67    // CoreIPC::Connection::Client
68    virtual void didReceiveMessage(CoreIPC::Connection*, CoreIPC::MessageDecoder&) OVERRIDE;
69    virtual void didReceiveSyncMessage(CoreIPC::Connection*, CoreIPC::MessageDecoder&, OwnPtr<CoreIPC::MessageEncoder>&) OVERRIDE;
70    virtual void didClose(CoreIPC::Connection*);
71    virtual void didReceiveInvalidMessage(CoreIPC::Connection*, CoreIPC::StringReference messageReceiverName, CoreIPC::StringReference messageName) OVERRIDE;
72
73    // Message handlers.
74    void didReceiveSyncPluginProcessConnectionMessage(CoreIPC::Connection*, CoreIPC::MessageDecoder&, OwnPtr<CoreIPC::MessageEncoder>&);
75    void setException(const String&);
76
77    PluginProcessConnectionManager* m_pluginProcessConnectionManager;
78    uint64_t m_pluginProcessToken;
79
80    // The connection from the web process to the plug-in process.
81    RefPtr<CoreIPC::Connection> m_connection;
82
83    // The plug-ins. We use a weak reference to the plug-in proxies because the plug-in view holds the strong reference.
84    HashMap<uint64_t, PluginProxy*> m_plugins;
85
86    RefPtr<NPRemoteObjectMap> m_npRemoteObjectMap;
87
88    bool m_supportsAsynchronousPluginInitialization;
89};
90
91} // namespace WebKit
92
93#endif // ENABLE(PLUGIN_PROCESS)
94
95#endif // PluginProcessConnection_h
96