xpcom/threads/nsThreadManager.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 Mozilla code.
  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  *  Darin Fisher <darin@meer.net>
  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 nsThreadManager_h__
  40 #define nsThreadManager_h__
  41
  42 #include "mozilla/Mutex.h"
  43 #include "nsIThreadManager.h"
  44 #include "nsRefPtrHashtable.h"
  45 #include "nsThread.h"
  46
  47 class nsIRunnable;
  48
  49 class nsThreadManager : public nsIThreadManager
  50 {
  51 public:
  52   NS_DECL_ISUPPORTS
  53   NS_DECL_NSITHREADMANAGER
  54
  55   static nsThreadManager *get() {
  56     return &sInstance;
  57   }
  58
  59   nsresult Init();
  60
  61   // Shutdown all threads.  This function should only be called on the main
  62   // thread of the application process.
  63   void Shutdown();
  64
  65   // Called by nsThread to inform the ThreadManager it exists.  This method
  66   // must be called when the given thread is the current thread.
  67   void RegisterCurrentThread(nsThread *thread);
  68
  69   // Called by nsThread to inform the ThreadManager it is going away.  This
  70   // method must be called when the given thread is the current thread.
  71   void UnregisterCurrentThread(nsThread *thread);
  72
  73   // Returns the current thread.  Returns null if OOM or if ThreadManager isn't
  74   // initialized.
  75   nsThread *GetCurrentThread();
  76
  77   // This needs to be public in order to support static instantiation of this
  78   // class with older compilers (e.g., egcs-2.91.66).
  79   ~nsThreadManager() {}
  80
  81 private:
  82   nsThreadManager()
  83     : mCurThreadIndex(0)
  84     , mMainPRThread(nsnull)
  85     , mLock(nsnull)
  86     , mInitialized(false) {
  87   }
  88
  89   static nsThreadManager sInstance;
  90
  91   nsRefPtrHashtable<nsVoidPtrHashKey, nsThread> mThreadsByPRThread;
  92   PRUintn             mCurThreadIndex;  // thread-local-storage index
  93   nsRefPtr<nsThread>  mMainThread;
  94   PRThread           *mMainPRThread;
  95   // This is a pointer in order to allow creating nsThreadManager from
  96   // the static context in debug builds.
  97   nsAutoPtr<mozilla::Mutex> mLock;  // protects tables
  98   bool                mInitialized;
  99 };
 100
 101 #define NS_THREADMANAGER_CLASSNAME "nsThreadManager"
 102 #define NS_THREADMANAGER_CID                       \
 103 { /* 7a4204c6-e45a-4c37-8ebb-6709a22c917c */       \
 104   0x7a4204c6,                                      \
 105   0xe45a,                                          \
 106   0x4c37,                                          \
 107   {0x8e, 0xbb, 0x67, 0x09, 0xa2, 0x2c, 0x91, 0x7c} \
 108 }
 109
 110 #endif  // nsThreadManager_h__