xpcom/threads/nsIThreadManager.idl

   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 #include "nsISupports.idl"
  40
  41 [ptr] native PRThread(PRThread);
  42
  43 interface nsIThread;
  44
  45 /**
  46  * An interface for creating and locating nsIThread instances.
  47  */
  48 [scriptable, uuid(056216f5-8803-46b4-9199-d95bc1f0446f)]
  49 interface nsIThreadManager : nsISupports
  50 {
  51   /**
  52    * Create a new thread (a global, user PRThread).
  53    *
  54    * @param creationFlags
  55    *   Reserved for future use.  Pass 0.
  56    *
  57    * @returns
  58    *   The newly created nsIThread object.
  59    */
  60   nsIThread newThread(in unsigned long creationFlags);
  61
  62   /**
  63    * Get the nsIThread object (if any) corresponding to the given PRThread.
  64    * This method returns null if there is no corresponding nsIThread.
  65    *
  66    * @param prthread
  67    *   The PRThread of the nsIThread being requested.
  68    *
  69    * @returns
  70    *   The nsIThread object corresponding to the given PRThread or null if no
  71    *   such nsIThread exists.
  72    */
  73   [noscript] nsIThread getThreadFromPRThread(in PRThread prthread);
  74
  75   /**
  76    * Get the main thread.
  77    */
  78   readonly attribute nsIThread mainThread;
  79
  80   /**
  81    * Get the current thread.  If the calling thread does not already have a
  82    * nsIThread associated with it, then a new nsIThread will be created and
  83    * associated with the current PRThread.
  84    */
  85   readonly attribute nsIThread currentThread;
  86
  87   /**
  88    * This attribute is true if the calling thread is the main thread of the
  89    * application process.
  90    */
  91   readonly attribute boolean isMainThread;
  92 };