Back to index

lightning-sunbird  0.9+nobinonly
TimerThread.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * ***** BEGIN LICENSE BLOCK *****
00005  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00006  *
00007  * The contents of this file are subject to the Mozilla Public License Version
00008  * 1.1 (the "License"); you may not use this file except in compliance with
00009  * the License. You may obtain a copy of the License at
00010  * http://www.mozilla.org/MPL/
00011  *
00012  * Software distributed under the License is distributed on an "AS IS" basis,
00013  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00014  * for the specific language governing rights and limitations under the
00015  * License.
00016  *
00017  * The Original Code is mozilla.org code.
00018  *
00019  * The Initial Developer of the Original Code is
00020  * Netscape Communications Corporation.
00021  * Portions created by the Initial Developer are Copyright (C) 2001
00022  * the Initial Developer. All Rights Reserved.
00023  *
00024  * Contributor(s):
00025  *   Stuart Parmenter <pavlov@netscape.com>
00026  *
00027  * Alternatively, the contents of this file may be used under the terms of
00028  * either of the GNU General Public License Version 2 or later (the "GPL"),
00029  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00030  * in which case the provisions of the GPL or the LGPL are applicable instead
00031  * of those above. If you wish to allow use of your version of this file only
00032  * under the terms of either the GPL or the LGPL, and not to allow others to
00033  * use your version of this file under the terms of the MPL, indicate your
00034  * decision by deleting the provisions above and replace them with the notice
00035  * and other provisions required by the GPL or the LGPL. If you do not delete
00036  * the provisions above, a recipient may use your version of this file under
00037  * the terms of any one of the MPL, the GPL or the LGPL.
00038  *
00039  * ***** END LICENSE BLOCK ***** */
00040 
00041 #ifndef TimerThread_h___
00042 #define TimerThread_h___
00043 
00044 #include "nsIEventQueueService.h"
00045 #include "nsIObserver.h"
00046 #include "nsIRunnable.h"
00047 #include "nsIThread.h"
00048 
00049 #include "nsTimerImpl.h"
00050 
00051 #include "nsVoidArray.h"
00052 
00053 #include "prcvar.h"
00054 #include "prinrval.h"
00055 #include "prlock.h"
00056 
00057 class TimerThread : public nsIRunnable,
00058                     public nsIObserver
00059 {
00060 public:
00061   TimerThread();
00062   NS_HIDDEN_(nsresult) InitLocks();
00063 
00064   NS_DECL_ISUPPORTS
00065   NS_DECL_NSIRUNNABLE
00066   NS_DECL_NSIOBSERVER
00067   
00068   NS_HIDDEN_(nsresult) Init();
00069   NS_HIDDEN_(nsresult) Shutdown();
00070 
00071   nsresult AddTimer(nsTimerImpl *aTimer);
00072   nsresult TimerDelayChanged(nsTimerImpl *aTimer);
00073   nsresult RemoveTimer(nsTimerImpl *aTimer);
00074 
00075 #define FILTER_DURATION         1e3     /* one second */
00076 #define FILTER_FEEDBACK_MAX     100     /* 1/10th of a second */
00077 
00078   void UpdateFilter(PRUint32 aDelay, PRIntervalTime aTimeout,
00079                     PRIntervalTime aNow);
00080 
00081   // For use by nsTimerImpl::Fire()
00082   nsCOMPtr<nsIEventQueueService> mEventQueueService;
00083 
00084   void DoBeforeSleep();
00085   void DoAfterSleep();
00086 
00087 private:
00088   ~TimerThread();
00089 
00090   PRInt32 mInitInProgress;
00091   PRBool  mInitialized;
00092 
00093   // These two internal helper methods must be called while mLock is held.
00094   // AddTimerInternal returns the position where the timer was added in the
00095   // list, or -1 if it failed.
00096   PRInt32 AddTimerInternal(nsTimerImpl *aTimer);
00097   PRBool  RemoveTimerInternal(nsTimerImpl *aTimer);
00098 
00099   nsCOMPtr<nsIThread> mThread;
00100   PRLock *mLock;
00101   PRCondVar *mCondVar;
00102 
00103   PRPackedBool mShutdown;
00104   PRPackedBool mWaiting;
00105   PRPackedBool mSleeping;
00106   
00107   nsVoidArray mTimers;
00108 
00109 #define DELAY_LINE_LENGTH_LOG2  5
00110 #define DELAY_LINE_LENGTH_MASK  PR_BITMASK(DELAY_LINE_LENGTH_LOG2)
00111 #define DELAY_LINE_LENGTH       PR_BIT(DELAY_LINE_LENGTH_LOG2)
00112 
00113   PRInt32  mDelayLine[DELAY_LINE_LENGTH];
00114   PRUint32 mDelayLineCounter;
00115   PRUint32 mMinTimerPeriod;     // milliseconds
00116   PRInt32  mTimeoutAdjustment;
00117 };
00118 
00119 #endif /* TimerThread_h___ */