1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
// Copyright 2008, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#ifndef CHROME_WEBKIT_GLUE_PLUGIN_CHANNEL_BASE_H__
#define CHROME_WEBKIT_GLUE_PLUGIN_CHANNEL_BASE_H__
#include <hash_map>
#include <string>
#include "base/basictypes.h"
#include "base/message_loop.h"
#include "base/ref_counted.h"
#include "base/scoped_ptr.h"
#include "chrome/common/ipc_sync_channel.h"
#include "chrome/common/message_router.h"
// Encapsulates an IPC channel between a renderer and a plugin process.
class PluginChannelBase : public IPC::Channel::Listener,
public IPC::Message::Sender,
public base::RefCountedThreadSafe<PluginChannelBase> {
public:
virtual ~PluginChannelBase();
// WebPlugin[Delegate] call these on construction and destruction to setup
// the routing and manage lifetime of this object. This is also called by
// NPObjectProxy and NPObjectStub. However the latter don't control the
// lifetime of this object (by passing true for npobject) because we don't
// want a leak of an NPObject in a plugin to keep the channel around longer
// than necessary.
void AddRoute(int route_id, IPC::Channel::Listener* listener, bool npobject);
void RemoveRoute(int route_id);
// IPC::Message::Sender implementation:
virtual bool Send(IPC::Message* msg);
int peer_pid() { return peer_pid_; }
std::wstring channel_name() const { return channel_name_; }
// Returns the number of open plugin channels in this process.
static int Count();
// Returns a new route id.
virtual int GenerateRouteID() = 0;
// Returns whether the channel is valid or not. A channel is invalid
// if it is disconnected due to a channel error.
bool channel_valid() {
return channel_valid_;
}
static void CleanupChannels();
protected:
typedef PluginChannelBase* (*PluginChannelFactory)();
// Returns a PluginChannelBase derived object for the given channel name.
// If an existing channel exists returns that object, otherwise creates a
// new one. Even though on creation the object is refcounted, each caller
// must still ref count the returned value. When there are no more routes
// on the channel and its ref count is 0, the object deletes itself.
static PluginChannelBase* GetChannel(
const std::wstring& channel_name, IPC::Channel::Mode mode,
PluginChannelFactory factory, MessageLoop* ipc_message_loop,
bool create_pipe_now);
// Called on the worker thread
PluginChannelBase();
virtual void CleanUp() { }
// Implemented by derived classes to handle control messages
virtual void OnControlMessageReceived(const IPC::Message& msg);
// IPC::Channel::Listener implementation:
virtual void OnMessageReceived(const IPC::Message& msg);
virtual void OnChannelConnected(int32 peer_pid);
virtual void OnChannelError();
// If this is set, sync messages that are sent will only unblock the receiver
// if this channel is in the middle of a dispatch.
void SendUnblockingOnlyDuringDispatch();
virtual bool Init(MessageLoop* ipc_message_loop, bool create_pipe_now);
scoped_ptr<IPC::SyncChannel> channel_;
private:
IPC::Channel::Mode mode_;
std::wstring channel_name_;
int plugin_count_;
int peer_pid_;
// true when in the middle of a RemoveRoute call
bool in_remove_route_;
// Keep track of all the registered NPObjects proxies/stubs so that when the
// channel is closed we can inform them.
typedef stdext::hash_map<int, IPC::Channel::Listener*> ListenerMap;
ListenerMap npobject_listeners_;
// Used to implement message routing functionality to WebPlugin[Delegate]
// objects
MessageRouter router_;
// A channel is invalid if it is disconnected as a result of a channel
// error. This flag is used to indicate the same.
bool channel_valid_;
// If true, sync messages will only be marked as unblocking if the channel is
// in the middle of dispatching a message.
bool send_unblocking_only_during_dispatch_;
int in_dispatch_;
DISALLOW_EVIL_CONSTRUCTORS(PluginChannelBase);
};
#endif // CHROME_WEBKIT_GLUE_PLUGIN_CHANNEL_BASE_H__
|
