content/public/browser/render_view_host_observer.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_PUBLIC_BROWSER_RENDER_VIEW_HOST_OBSERVER_H_
   6 #define CONTENT_PUBLIC_BROWSER_RENDER_VIEW_HOST_OBSERVER_H_
   7
   8 #include "base/compiler_specific.h"
   9 #include "ipc/ipc_listener.h"
  10 #include "ipc/ipc_sender.h"
  11 #include "content/common/content_export.h"
  12
  13 class GURL;
  14
  15 namespace content {
  16
  17 class RenderViewHost;
  18 class RenderViewHostImpl;
  19
  20 // An observer API implemented by classes which want to filter IPC messages from
  21 // RenderViewHost.
  22 class CONTENT_EXPORT RenderViewHostObserver : public IPC::Listener,
  23                                               public IPC::Sender {
  24  public:
  25
  26  protected:
  27   explicit RenderViewHostObserver(RenderViewHost* render_view_host);
  28
  29   virtual ~RenderViewHostObserver();
  30
  31   // Invoked after the RenderViewHost is created in the renderer process.  After
  32   // this point, messages can be sent to it (or to observers in the renderer).
  33   virtual void RenderViewHostInitialized();
  34
  35   // Invoked when the RenderViewHost is being destroyed. Gives subclasses a
  36   // chance to cleanup.  The base implementation will delete the object.
  37   // |render_view_host| is passed as an argument since render_view_host() will
  38   // return NULL once this method enters.
  39   virtual void RenderViewHostDestroyed(RenderViewHost* render_view_host);
  40
  41   // IPC::Listener implementation.
  42   virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE;
  43
  44   // IPC::Sender implementation.
  45   virtual bool Send(IPC::Message* message) OVERRIDE;
  46
  47   RenderViewHost* render_view_host() const;
  48   int routing_id() { return routing_id_; }
  49
  50  private:
  51   friend class RenderViewHostImpl;
  52
  53   // Invoked from RenderViewHost. Invokes RenderViewHostDestroyed and NULL out
  54   // |render_view_host_|.
  55   void RenderViewHostDestruction();
  56
  57   RenderViewHostImpl* render_view_host_;
  58
  59   // The routing ID of the associated RenderViewHost.
  60   int routing_id_;
  61
  62   DISALLOW_COPY_AND_ASSIGN(RenderViewHostObserver);
  63 };
  64
  65 }  // namespace content
  66
  67 #endif  // CONTENT_PUBLIC_BROWSER_RENDER_VIEW_HOST_OBSERVER_H_