xpcom/threads/TimerThread.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   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 mozilla.org code.
  18  *
  19  * The Initial Developer of the Original Code is
  20  * Netscape Communications Corporation.
  21  * Portions created by the Initial Developer are Copyright (C) 2001
  22  * the Initial Developer. All Rights Reserved.
  23  *
  24  * Contributor(s):
  25  *   Stuart Parmenter <pavlov@netscape.com>
  26  *
  27  * Alternatively, the contents of this file may be used under the terms of
  28  * either of the GNU General Public License Version 2 or later (the "GPL"),
  29  * or 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 TimerThread_h___
  42 #define TimerThread_h___
  43
  44 #include "nsIObserver.h"
  45 #include "nsIRunnable.h"
  46 #include "nsIThread.h"
  47
  48 #include "nsTimerImpl.h"
  49
  50 #include "nsTArray.h"
  51
  52 #include "prcvar.h"
  53 #include "mozilla/TimeStamp.h"
  54 #include "prlock.h"
  55
  56 class TimerThread : public nsIRunnable,
  57                     public nsIObserver
  58 {
  59 public:
  60   typedef mozilla::TimeStamp TimeStamp;
  61   typedef mozilla::TimeDuration TimeDuration;
  62
  63   TimerThread();
  64   NS_HIDDEN_(nsresult) InitLocks();
  65
  66   NS_DECL_ISUPPORTS
  67   NS_DECL_NSIRUNNABLE
  68   NS_DECL_NSIOBSERVER
  69
  70   NS_HIDDEN_(nsresult) Init();
  71   NS_HIDDEN_(nsresult) Shutdown();
  72
  73   nsresult AddTimer(nsTimerImpl *aTimer);
  74   nsresult TimerDelayChanged(nsTimerImpl *aTimer);
  75   nsresult RemoveTimer(nsTimerImpl *aTimer);
  76
  77 #define FILTER_DURATION         1e3     /* one second */
  78 #define FILTER_FEEDBACK_MAX     100     /* 1/10th of a second */
  79
  80   void UpdateFilter(PRUint32 aDelay, TimeStamp aTimeout,
  81                     TimeStamp aNow);
  82
  83   void DoBeforeSleep();
  84   void DoAfterSleep();
  85
  86 private:
  87   ~TimerThread();
  88
  89   PRInt32 mInitInProgress;
  90   PRBool  mInitialized;
  91
  92   // These two internal helper methods must be called while mLock is held.
  93   // AddTimerInternal returns the position where the timer was added in the
  94   // list, or -1 if it failed.
  95   PRInt32 AddTimerInternal(nsTimerImpl *aTimer);
  96   PRBool  RemoveTimerInternal(nsTimerImpl *aTimer);
  97   void    ReleaseTimerInternal(nsTimerImpl *aTimer);
  98
  99   nsCOMPtr<nsIThread> mThread;
 100   PRLock *mLock;
 101   PRCondVar *mCondVar;
 102
 103   PRPackedBool mShutdown;
 104   PRPackedBool mWaiting;
 105   PRPackedBool mSleeping;
 106
 107   nsTArray<nsTimerImpl*> mTimers;
 108
 109 #define DELAY_LINE_LENGTH_LOG2  5
 110 #define DELAY_LINE_LENGTH_MASK  PR_BITMASK(DELAY_LINE_LENGTH_LOG2)
 111 #define DELAY_LINE_LENGTH       PR_BIT(DELAY_LINE_LENGTH_LOG2)
 112
 113   PRInt32  mDelayLine[DELAY_LINE_LENGTH]; // milliseconds
 114   PRUint32 mDelayLineCounter;
 115   PRUint32 mMinTimerPeriod;     // milliseconds
 116   TimeDuration mTimeoutAdjustment;
 117 };
 118
 119 #endif /* TimerThread_h___ */