dom/plugins/ChildTimer.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  * vim: sw=2 ts=8 et :
   3  */
   4 /* ***** BEGIN LICENSE BLOCK *****
   5  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   6  *
   7  * The contents of this file are subject to the Mozilla Public License Version
   8  * 1.1 (the "License"); you may not use this file except in compliance with
   9  * the License. You may obtain a copy of the License at
  10  * http://www.mozilla.org/MPL/
  11  *
  12  * Software distributed under the License is distributed on an "AS IS" basis,
  13  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  14  * for the specific language governing rights and limitations under the
  15  * License.
  16  *
  17  * The Original Code is Firefox.
  18  *
  19  * The Initial Developer of the Original Code is
  20  * the Mozilla Foundation <http://www.mozilla.org>.
  21  *
  22  * Portions created by the Initial Developer are Copyright (C) 2010
  23  * the Initial Developer. All Rights Reserved.
  24  *
  25  * Contributor(s):
  26  *
  27  * Alternatively, the contents of this file may be used under the terms of
  28  * either the GNU General Public License Version 2 or later (the "GPL"), or
  29  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  30  * in which case the provisions of the GPL or the LGPL are applicable instead
  31  * of those above. If you wish to allow use of your version of this file only
  32  * under the terms of either the GPL or the LGPL, and not to allow others to
  33  * use your version of this file under the terms of the MPL, indicate your
  34  * decision by deleting the provisions above and replace them with the notice
  35  * and other provisions required by the GPL or the LGPL. If you do not delete
  36  * the provisions above, a recipient may use your version of this file under
  37  * the terms of any one of the MPL, the GPL or the LGPL.
  38  *
  39  * ***** END LICENSE BLOCK ***** */
  40
  41 #ifndef mozilla_plugins_ChildTimer_h
  42 #define mozilla_plugins_ChildTimer_h
  43
  44 #include "PluginMessageUtils.h"
  45 #include "npapi.h"
  46 #include "base/timer.h"
  47
  48 namespace mozilla {
  49 namespace plugins {
  50
  51 class PluginInstanceChild;
  52 typedef void (*TimerFunc)(NPP npp, uint32_t timerID);
  53
  54 class ChildTimer
  55 {
  56 public:
  57   /**
  58    * If initialization failed, ID() will return 0.
  59    */
  60   ChildTimer(PluginInstanceChild* instance,
  61              uint32_t interval,
  62              bool repeat,
  63              TimerFunc func);
  64   ~ChildTimer() { }
  65
  66   uint32_t ID() const { return mID; }
  67
  68   class IDComparator
  69   {
  70   public:
  71     PRBool Equals(ChildTimer* t, uint32_t id) const {
  72       return t->ID() == id;
  73     }
  74   };
  75
  76 private:
  77   PluginInstanceChild* mInstance;
  78   TimerFunc mFunc;
  79   bool mRepeating;
  80   uint32_t mID;
  81   base::RepeatingTimer<ChildTimer> mTimer;
  82
  83   void Run();
  84
  85   static uint32_t gNextTimerID;
  86 };
  87
  88 } // namespace plugins
  89 } // namespace mozilla
  90
  91 #endif // mozilla_plugins_ChildTimer_h