blob: ffe5c79cc9b2cac5d4452665993213427e33eab9 [file] [log] [blame]
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <vector>
#include "base/memory/ref_counted.h"
#include "base/process/process.h"
#include "build/build_config.h"
#include "content/child/npapi/np_channel_base.h"
#include "content/child/scoped_child_process_reference.h"
#include "content/plugin/webplugin_delegate_stub.h"
namespace base {
class WaitableEvent;
namespace content {
// Encapsulates an IPC channel between the plugin process and one renderer
// process. On the renderer side there's a corresponding PluginChannelHost.
class PluginChannel : public NPChannelBase {
// Get a new PluginChannel object for the current process to talk to the
// given renderer process. The renderer ID is an opaque unique ID generated
// by the browser.
static PluginChannel* GetPluginChannel(
int renderer_id, base::MessageLoopProxy* ipc_message_loop);
// Send a message to all renderers that the process is going to shutdown.
static void NotifyRenderersOfPendingShutdown();
// IPC::Listener:
virtual bool Send(IPC::Message* msg) OVERRIDE;
virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE;
virtual void OnChannelError() OVERRIDE;
int renderer_id() { return renderer_id_; }
virtual int GenerateRouteID() OVERRIDE;
// Returns the event that's set when a call to the renderer causes a modal
// dialog to come up.
virtual base::WaitableEvent* GetModalDialogEvent(int render_view_id) OVERRIDE;
bool in_send() { return in_send_ != 0; }
bool incognito() { return incognito_; }
void set_incognito(bool value) { incognito_ = value; }
#if defined(OS_POSIX)
int TakeRendererFileDescriptor() {
return channel_->TakeClientFileDescriptor();
virtual ~PluginChannel();
// NPChannelBase::
virtual void CleanUp() OVERRIDE;
virtual bool Init(base::MessageLoopProxy* ipc_message_loop,
bool create_pipe_now,
base::WaitableEvent* shutdown_event) OVERRIDE;
class MessageFilter;
// Called on the plugin thread
virtual bool OnControlMessageReceived(const IPC::Message& msg) OVERRIDE;
static NPChannelBase* ClassFactory() { return new PluginChannel(); }
void OnCreateInstance(const std::string& mime_type, int* instance_id);
void OnDestroyInstance(int instance_id, IPC::Message* reply_msg);
void OnGenerateRouteID(int* route_id);
void OnClearSiteData(const std::string& site,
uint64 flags,
uint64 max_age);
void OnDidAbortLoading(int render_view_id);
std::vector<scoped_refptr<WebPluginDelegateStub> > plugin_stubs_;
ScopedChildProcessReference process_ref_;
// The id of the renderer who is on the other side of the channel.
int renderer_id_;
int in_send_; // Tracks if we're in a Send call.
bool log_messages_; // True if we should log sent and received messages.
bool incognito_; // True if the renderer is in incognito mode.
scoped_refptr<MessageFilter> filter_; // Handles the modal dialog events.
// Dummy NPP value used in the plugin process to represent entities other
// that other plugin instances for the purpose of object ownership tracking.
scoped_ptr<struct _NPP> npp_;
} // namespace content