xpcom/base/nsMemoryImpl.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef nsMemoryImpl_h__
  39 #define nsMemoryImpl_h__
  40
  41 #include "nsIMemory.h"
  42 #include "nsIRunnable.h"
  43 #include "prtime.h"
  44
  45 // nsMemoryImpl is a static object. We can do this because it doesn't have
  46 // a constructor/destructor or any instance members. Please don't add
  47 // instance member variables, only static member variables.
  48
  49 class nsMemoryImpl : public nsIMemory
  50 {
  51 public:
  52     // We don't use the generic macros because we are a special static object
  53     NS_IMETHOD QueryInterface(REFNSIID aIID, void** aResult);
  54     NS_IMETHOD_(nsrefcnt) AddRef(void) { return 1; }
  55     NS_IMETHOD_(nsrefcnt) Release(void) { return 1; }
  56
  57     NS_DECL_NSIMEMORY
  58
  59     static nsresult Create(nsISupports* outer,
  60                            const nsIID& aIID, void **aResult);
  61
  62     NS_HIDDEN_(nsresult) FlushMemory(const PRUnichar* aReason, PRBool aImmediate);
  63     NS_HIDDEN_(nsresult) RunFlushers(const PRUnichar* aReason);
  64
  65 protected:
  66     struct FlushEvent : public nsIRunnable {
  67         NS_DECL_ISUPPORTS_INHERITED
  68         NS_DECL_NSIRUNNABLE
  69         const PRUnichar* mReason;
  70     };
  71
  72     static PRInt32    sIsFlushing;
  73     static FlushEvent sFlushEvent;
  74     static PRIntervalTime sLastFlushTime;
  75 };
  76
  77 #endif // nsMemoryImpl_h__