dom/src/threads/nsDOMWorkerPool.h

   1 /* -*- Mode: c++; c-basic-offset: 4; indent-tabs-mode: nil; tab-width: 40 -*- */
   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 worker threads.
  16  *
  17  * The Initial Developer of the Original Code is
  18  *   Mozilla Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2008
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Vladimir Vukicevic <vladimir@pobox.com> (Original Author)
  24  *   Ben Turner <bent.mozilla@gmail.com>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #ifndef __NSDOMWORKERPOOL_H__
  41 #define __NSDOMWORKERPOOL_H__
  42
  43 // Other includes
  44 #include "jsapi.h"
  45 #include "nsCOMPtr.h"
  46 #include "nsStringGlue.h"
  47 #include "nsTArray.h"
  48 #include "prmon.h"
  49
  50 class nsDOMWorker;
  51 class nsIDocument;
  52 class nsIScriptContext;
  53 class nsIScriptError;
  54 class nsIScriptGlobalObject;
  55
  56 class nsDOMWorkerPool
  57 {
  58 public:
  59   nsDOMWorkerPool(nsIScriptGlobalObject* aGlobalObject,
  60                   nsIDocument* aDocument);
  61
  62   NS_IMETHOD_(nsrefcnt) AddRef();
  63   NS_IMETHOD_(nsrefcnt) Release();
  64
  65   nsIScriptContext* ScriptContext();
  66
  67   nsIScriptGlobalObject* ScriptGlobalObject() {
  68     return mParentGlobal;
  69   }
  70
  71   nsIDocument* ParentDocument() {
  72     return mParentDocument;
  73   }
  74
  75   nsresult Init();
  76
  77   void Cancel();
  78   void Suspend();
  79   void Resume();
  80
  81   nsresult NoteWorker(nsDOMWorker* aWorker);
  82   void NoteDyingWorker(nsDOMWorker* aWorker);
  83
  84   PRMonitor* Monitor() {
  85     return mMonitor;
  86   }
  87
  88 private:
  89   virtual ~nsDOMWorkerPool();
  90
  91   void GetWorkers(nsTArray<nsDOMWorker*>& aArray);
  92
  93   nsAutoRefCnt mRefCnt;
  94
  95   // Reference to the window that created and owns this pool.
  96   nsCOMPtr<nsIScriptGlobalObject> mParentGlobal;
  97
  98   // Reference to the document that created this pool.
  99   nsCOMPtr<nsIDocument> mParentDocument;
 100
 101   // Weak array of workers. The idea is that workers can be garbage collected
 102   // independently of the owning pool and other workers.
 103   nsTArray<nsDOMWorker*> mWorkers;
 104
 105   // Monitor for suspending and resuming workers.
 106   PRMonitor* mMonitor;
 107
 108   PRPackedBool mCanceled;
 109   PRPackedBool mSuspended;
 110 };
 111
 112 #endif /* __NSDOMWORKERPOOL_H__ */