content/renderer/npapi/plugin_channel_host.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CONTENT_RENDERER_NPAPI_PLUGIN_CHANNEL_HOST_H_
   6 #define CONTENT_RENDERER_NPAPI_PLUGIN_CHANNEL_HOST_H_
   7
   8 #include "base/containers/hash_tables.h"
   9 #include "content/child/npapi/np_channel_base.h"
  10 #include "ipc/ipc_channel_handle.h"
  11
  12 namespace IPC {
  13 class AttachmentBroker;
  14 }
  15
  16 namespace content {
  17 class NPObjectBase;
  18
  19 // Encapsulates an IPC channel between the renderer and one plugin process.
  20 // On the plugin side there's a corresponding PluginChannel.
  21 class PluginChannelHost : public NPChannelBase {
  22  public:
  23 #if defined(OS_MACOSX)
  24   // TODO(shess): Debugging for http://crbug.com/97285 .  See comment
  25   // in plugin_channel_host.cc.
  26   static bool* GetRemoveTrackingFlag();
  27 #endif
  28   static PluginChannelHost* GetPluginChannelHost(
  29       const IPC::ChannelHandle& channel_handle,
  30       base::SingleThreadTaskRunner* ipc_task_runner,
  31       IPC::AttachmentBroker* broker);
  32
  33   bool Init(base::SingleThreadTaskRunner* ipc_task_runner,
  34             bool create_pipe_now,
  35             base::WaitableEvent* shutdown_event,
  36             IPC::AttachmentBroker* broker) override;
  37
  38   int GenerateRouteID() override;
  39
  40   void AddRoute(int route_id, IPC::Listener* listener,
  41                 NPObjectBase* npobject);
  42   void RemoveRoute(int route_id);
  43
  44   // NPChannelBase override:
  45   bool Send(IPC::Message* msg) override;
  46
  47   // IPC::Listener override
  48   void OnChannelError() override;
  49
  50   static void Broadcast(IPC::Message* message) {
  51     NPChannelBase::Broadcast(message);
  52   }
  53
  54   bool expecting_shutdown() { return expecting_shutdown_; }
  55
  56  private:
  57   // Called on the render thread
  58   PluginChannelHost();
  59   ~PluginChannelHost() override;
  60
  61   static NPChannelBase* ClassFactory() { return new PluginChannelHost(); }
  62
  63   bool OnControlMessageReceived(const IPC::Message& message) override;
  64   void OnSetException(const std::string& message);
  65   void OnPluginShuttingDown();
  66
  67   // Keep track of all the registered WebPluginDelegeProxies to
  68   // inform about OnChannelError
  69   typedef base::hash_map<int, IPC::Listener*> ProxyMap;
  70   ProxyMap proxies_;
  71
  72   // True if we are expecting the plugin process to go away - in which case,
  73   // don't treat it as a crash.
  74   bool expecting_shutdown_;
  75
  76   DISALLOW_COPY_AND_ASSIGN(PluginChannelHost);
  77 };
  78
  79 }  // namespace content
  80
  81 #endif  // CONTENT_RENDERER_NPAPI_PLUGIN_CHANNEL_HOST_H_