Define the public version of the browser side RenderProcessHost interface. This interface is not ...

content/browser/renderer_host/render_process_host_impl.h

 // Copyright (c) 2011 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.
 
 #ifndef CONTENT_BROWSER_RENDERER_HOST_BROWSER_RENDER_PROCESS_HOST_H_

[jam, 2011/11/16 22:10:19]

nit: ifdef guard

[ananta, 2011/11/17 13:34:45]

Done.

 #define CONTENT_BROWSER_RENDERER_HOST_BROWSER_RENDER_PROCESS_HOST_H_
 #pragma once
 
 #include <map>
 #include <queue>
 #include <string>
 
 #include "base/memory/scoped_ptr.h"
 #include "base/process.h"
 #include "base/synchronization/waitable_event_watcher.h"
 #include "base/timer.h"
 #include "content/browser/child_process_launcher.h"
 #include "content/common/content_export.h"
-#include "content/browser/renderer_host/render_process_host.h"
+#include "content/public/browser/render_process_host.h"
+#include "ipc/ipc_channel_proxy.h"
 #include "ui/gfx/surface/transport_dib.h"
 
 class CommandLine;
 class RendererMainThread;
 class RenderWidgetHelper;
 
 namespace base {
 class WaitableEvent;
 }
 
 // Implements a concrete RenderProcessHost for the browser process for talking
 // to actual renderer processes (as opposed to mocks).
 //
 // Represents the browser side of the browser <--> renderer communication
 // channel. There will be one RenderProcessHost per renderer process.
 //
 // This object is refcounted so that it can release its resources when all
 // hosts using it go away.
 //
 // This object communicates back and forth with the RenderProcess object
 // running in the renderer process. Each RenderProcessHost and RenderProcess
 // keeps a list of RenderView (renderer) and TabContents (browser) which
 // are correlated with IDs. This way, the Views and the corresponding ViewHosts
 // communicate through the two process objects.
-class CONTENT_EXPORT BrowserRenderProcessHost
+class CONTENT_EXPORT RenderProcessHostImpl
     : public RenderProcessHost,
       public ChildProcessLauncher::Client,
       public base::WaitableEventWatcher::Delegate {
  public:
-  explicit BrowserRenderProcessHost(content::BrowserContext* browser_context);
-  virtual ~BrowserRenderProcessHost();
+  explicit RenderProcessHostImpl(content::BrowserContext* browser_context);
+  virtual ~RenderProcessHostImpl();
 
   // RenderProcessHost implementation (public portion).
-  virtual void EnableSendQueue();
-  virtual bool Init(bool is_accessibility_enabled);
-  virtual int GetNextRoutingID();
-  virtual void CancelResourceRequests(int render_widget_id);
-  virtual void CrossSiteSwapOutACK(const ViewMsg_SwapOut_Params& params);
+  virtual void EnableSendQueue() OVERRIDE;
+  virtual bool Init(bool is_accessibility_enabled) OVERRIDE;
+  virtual int GetNextRoutingID() OVERRIDE;
+  virtual void CancelResourceRequests(int render_widget_id) OVERRIDE;
+  virtual void CrossSiteSwapOutACK(const ViewMsg_SwapOut_Params& params)
+      OVERRIDE;
   virtual bool WaitForUpdateMsg(int render_widget_id,
                                 const base::TimeDelta& max_delay,
-                                IPC::Message* msg);
-  virtual void ReceivedBadMessage();
-  virtual void WidgetRestored();
-  virtual void WidgetHidden();
-  virtual int VisibleWidgetCount() const;
-  virtual bool FastShutdownIfPossible();
-  virtual void DumpHandles();
-  virtual base::ProcessHandle GetHandle();
-  virtual TransportDIB* GetTransportDIB(TransportDIB::Id dib_id);
+                                IPC::Message* msg) OVERRIDE;
+  virtual void ReceivedBadMessage() OVERRIDE;
+  virtual void WidgetRestored() OVERRIDE;
+  virtual void WidgetHidden() OVERRIDE;
+  virtual int VisibleWidgetCount() const OVERRIDE;
+  virtual bool FastShutdownIfPossible() OVERRIDE;
+  virtual void DumpHandles() OVERRIDE;
+  virtual base::ProcessHandle GetHandle() OVERRIDE;
+  virtual TransportDIB* GetTransportDIB(TransportDIB::Id dib_id) OVERRIDE;
   virtual void SetCompositingSurface(
       int render_widget_id,
-      gfx::PluginWindowHandle compositing_surface);
+      gfx::PluginWindowHandle compositing_surface) OVERRIDE;
+  // Returns the user browser context associated with this renderer process.

[jam, 2011/11/16 22:10:19]

nit: don't duplicate comment from interface

[ananta, 2011/11/17 13:34:45]

Done.

+  virtual content::BrowserContext* GetBrowserContext() const OVERRIDE;
+  virtual int GetID() const OVERRIDE;
+  virtual bool HasConnection() const OVERRIDE;
+  virtual void UpdateMaxPageID(int32 page_id) OVERRIDE;
+  virtual IPC::Channel::Listener* GetListenerByID(int routing_id) OVERRIDE;
+  virtual void SetIgnoreInputEvents(bool ignore_input_events) OVERRIDE;
+  virtual bool IgnoreInputEvents() const OVERRIDE;
+  virtual void Attach(IPC::Channel::Listener* listener, int routing_id)
+      OVERRIDE;
+  virtual void Release(int listener_id) OVERRIDE;
+  virtual void Cleanup() OVERRIDE;
+  virtual void ReportExpectingClose(int32 listener_id) OVERRIDE;
+  virtual void AddPendingView() OVERRIDE;
+  virtual void RemovePendingView() OVERRIDE;
+  virtual void SetSuddenTerminationAllowed(bool enabled) OVERRIDE;
+  virtual bool SuddenTerminationAllowed() const OVERRIDE;
+  virtual IPC::ChannelProxy* GetChannel() OVERRIDE;
+  virtual listeners_iterator ListenersIterator() OVERRIDE;
+  // Try to shutdown the associated render process as fast as possible, but

[jam, 2011/11/16 22:10:19]

nit: ditto

[ananta, 2011/11/17 13:34:45]

Done.

+  // only if |count| matches the number of render widgets that this process
+  // controls.
+  virtual bool FastShutdownForPageCount(size_t count) OVERRIDE;
+

[jam, 2011/11/16 22:10:19]

nit: extra line

[ananta, 2011/11/17 13:34:45]

Done.

+  virtual bool FastShutdownStarted() const OVERRIDE;
 
   // IPC::Channel::Sender via RenderProcessHost.
-  virtual bool Send(IPC::Message* msg);
+  virtual bool Send(IPC::Message* msg) OVERRIDE;
 
   // IPC::Channel::Listener via RenderProcessHost.
   virtual bool OnMessageReceived(const IPC::Message& msg) OVERRIDE;
   virtual void OnChannelConnected(int32 peer_pid) OVERRIDE;
   virtual void OnChannelError() OVERRIDE;
 
   // ChildProcessLauncher::Client implementation.
-  virtual void OnProcessLaunched();
+  virtual void OnProcessLaunched() OVERRIDE;
 
   // base::WaitableEventWatcher::Delegate implementation.
   virtual void OnWaitableEventSignaled(
       base::WaitableEvent* waitable_event) OVERRIDE;
 
+  // Returns how long the child has been idle. The definition of idle
+  // depends on when a derived class calls mark_child_process_activity_time().
+  // This is a rough indicator and its resolution should not be better than
+  // 10 milliseconds.
+  base::TimeDelta get_child_process_idle_time() const {
+    return base::TimeTicks::Now() - child_process_activity_time_;
+  }
+
+  // Call this function when it is evident that the child process is actively
+  // performing some operation, for example if we just received an IPC message.
+  void mark_child_process_activity_time() {
+    child_process_activity_time_ = base::TimeTicks::Now();
+  }
+
+ protected:
+  // A proxy for our IPC::Channel that lives on the IO thread (see
+  // browser_process.h)
+  scoped_ptr<IPC::ChannelProxy> channel_;
+
+  // The registered listeners. When this list is empty or all NULL, we should
+  // delete ourselves
+  IDMap<IPC::Channel::Listener> listeners_;
+
+  // The maximum page ID we've ever seen from the renderer process.
+  int32 max_page_id_;
+
+  // True if fast shutdown has been performed on this RPH.
+  bool fast_shutdown_started_;
+
+  // True if we've posted a DeleteTask and will be deleted soon.
+  bool deleting_soon_;
+
+  // The count of currently swapped out but pending RenderViews.  We have
+  // started to swap these in, so the renderer process should not exit if
+  // this count is non-zero.
+  int32 pending_views_;
+
  private:
   friend class VisitRelayingRenderProcessHost;
 
   // Creates and adds the IO thread message filters.
   void CreateMessageFilters();
 
   // Control message handlers.
   void OnShutdownRequest();
   void OnDumpHandlesDone();
   void SuddenTerminationChanged(bool enabled);
@@ skipping 28 matching lines @@
 
   // Does this process have backgrounded priority.
   bool backgrounded_;
 
   // Used to allow a RenderWidgetHost to intercept various messages on the
   // IO thread.
   scoped_refptr<RenderWidgetHelper> widget_helper_;
 
   // A map of transport DIB ids to cached TransportDIBs
   std::map<TransportDIB::Id, TransportDIB*> cached_dibs_;
+
   enum {
     // This is the maximum size of |cached_dibs_|
     MAX_MAPPED_TRANSPORT_DIBS = 3,
   };
 
   // Map a transport DIB from its Id and return it. Returns NULL on error.
   TransportDIB* MapTransportDIB(TransportDIB::Id dib_id);
 
   void ClearTransportDIBCache();
   // This is used to clear our cache five seconds after the last use.
-  base::DelayTimer<BrowserRenderProcessHost> cached_dibs_cleaner_;
+  base::DelayTimer<RenderProcessHostImpl> cached_dibs_cleaner_;
 
   // Used in single-process mode.
   scoped_ptr<RendererMainThread> in_process_renderer_;
 
   // True if this prcoess should have accessibility enabled;
   bool accessibility_enabled_;
 
   // True after Init() has been called. We can't just check channel_ because we
   // also reset that in the case of process termination.
   bool is_initialized_;
 
   // Used to launch and terminate the process without blocking the UI thread.
   scoped_ptr<ChildProcessLauncher> child_process_launcher_;
 
   // Messages we queue while waiting for the process handle.  We queue them here
   // instead of in the channel so that we ensure they're sent after init related
   // messages that are sent once the process handle is available.  This is
   // because the queued messages may have dependencies on the init messages.
   std::queue<IPC::Message*> queued_messages_;
 
 #if defined(OS_WIN)
   // Used to wait until the renderer dies to get an accurrate exit code.
   base::WaitableEventWatcher child_process_watcher_;
 #endif
 
-  DISALLOW_COPY_AND_ASSIGN(BrowserRenderProcessHost);
+  // The globally-unique identifier for this RPH.
+  int id_;
+
+  content::BrowserContext* browser_context_;
+
+  // set of listeners that expect the renderer process to close
+  std::set<int> listeners_expecting_close_;
+
+  // True if the process can be shut down suddenly.  If this is true, then we're
+  // sure that all the RenderViews in the process can be shutdown suddenly.  If
+  // it's false, then specific RenderViews might still be allowed to be shutdown
+  // suddenly by checking their SuddenTerminationAllowed() flag.  This can occur
+  // if one tab has an unload event listener but another tab in the same process
+  // doesn't.
+  bool sudden_termination_allowed_;
+
+  // Set to true if we shouldn't send input events.  We actually do the
+  // filtering for this at the render widget level.
+  bool ignore_input_events_;
+
+  // Records the last time we regarded the child process active.
+  base::TimeTicks child_process_activity_time_;
+
+  DISALLOW_COPY_AND_ASSIGN(RenderProcessHostImpl);
 };
 
 #endif  // CONTENT_BROWSER_RENDERER_HOST_BROWSER_RENDER_PROCESS_HOST_H_