extensions/metrics/src/nsWindowCollector.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim:set ts=2 sw=2 sts=2 et cindent: */
   3 /* ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is the Metrics extension.
  17  *
  18  * The Initial Developer of the Original Code is Google Inc.
  19  * Portions created by the Initial Developer are Copyright (C) 2006
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *  Brian Ryner <bryner@brianryner.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef nsWindowCollector_h_
  40 #define nsWindowCollector_h_
  41
  42 #include "nsIMetricsCollector.h"
  43 #include "nsIObserver.h"
  44 #include "nsTArray.h"
  45 #include "nsCOMPtr.h"
  46
  47 class nsIDOMWindow;
  48 class nsITimer;
  49
  50 // This file defines the window collector class, which monitors window
  51 // creation, opening, closing, and destruction, and records the events into
  52 // the metrics service. This information provides additional context for loads
  53 // into each window.
  54 //
  55 // The window collector also manages the list of assigned window ids, which
  56 // are shared by all interested collectors.
  57 //
  58 // Event descriptions:
  59 //
  60 // <window action="create"/>: logged on new window creation.
  61 // This window can correspond to a toplevel window or to a subframe.
  62 // Attributes:
  63 //   windowid: The id of the new window (uint16)
  64 //   parent: The id of the window's parent (uint16)
  65 //   chrome: Set to true if the window has a chrome docshell (boolean)
  66 //
  67 // <window action="open"/>: logged when window.open() is called.
  68 // This will be logged immediately following <windowcreate/> when a toplevel
  69 // window is opened.  It will never be logged for subframe windows.
  70 // Attributes:
  71 //   windowid: The id of the opened window (uint16)
  72 //   opener: The id of the window's opener (uint16)
  73 //
  74 // <window action="close"/>: logged when a toplevel window is closed.
  75 // Attributes:
  76 //   windowid: The id of the closed window (uint16)
  77 //
  78 // <window action="destroy"/>: logged when a window is destroyed.
  79 // Attributes:
  80 //   windowid: The id of the destroyed window (uint16).
  81
  82 class nsWindowCollector : public nsIMetricsCollector,
  83                           public nsIObserver
  84 {
  85  public:
  86   NS_DECL_ISUPPORTS
  87   NS_DECL_NSIMETRICSCOLLECTOR
  88   NS_DECL_NSIOBSERVER
  89
  90   nsWindowCollector();
  91
  92   // VC6 needs this to be public
  93   void LogWindowOpen(nsITimer *timer, nsISupports *subject);
  94
  95  private:
  96   ~nsWindowCollector();
  97
  98   // timer callback
  99   static void WindowOpenCallback(nsITimer *timer, void *closure);
 100
 101   // timers that we're using for deferred window open events
 102   nsTArray< nsCOMPtr<nsITimer> > mWindowOpenTimers;
 103 };
 104
 105 #define NS_WINDOWCOLLECTOR_CLASSNAME "Window Collector"
 106 #define NS_WINDOWCOLLECTOR_CID \
 107 { 0x56e37604, 0xd593, 0x47e4, {0x87, 0x1f, 0x76, 0x13, 0x64, 0x8e, 0x74, 0x2b}}
 108
 109 #endif // nsWindowCollector_h_