xpcom/threads/nsIEventTarget.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 interface nsIRunnable;
  42
  43 [scriptable, uuid(4e8febe4-6631-49dc-8ac9-308c1cb9b09c)]
  44 interface nsIEventTarget : nsISupports
  45 {
  46   /**
  47    * Dispatch an event to this event target.  This function may be called from
  48    * any thread, and it may be called re-entrantly.
  49    *
  50    * @param event
  51    *   The event to dispatch.
  52    * @param flags
  53    *   The flags modifying event dispatch.  The flags are described in detail
  54    *   below.
  55    *
  56    * @throws NS_ERROR_INVALID_ARG
  57    *   Indicates that event is null.
  58    * @throws NS_ERROR_UNEXPECTED
  59    *   Indicates that the thread is shutting down and has finished processing
  60    * events, so this event would never run and has not been dispatched.
  61    */
  62   void dispatch(in nsIRunnable event, in unsigned long flags);
  63
  64   /**
  65    * This flag specifies the default mode of event dispatch, whereby the event
  66    * is simply queued for later processing.  When this flag is specified,
  67    * dispatch returns immediately after the event is queued.
  68    */
  69   const unsigned long DISPATCH_NORMAL = 0;
  70
  71   /**
  72    * This flag specifies the synchronous mode of event dispatch, in which the
  73    * dispatch method does not return until the event has been processed.
  74    *
  75    * NOTE: passing this flag to dispatch may have the side-effect of causing
  76    * other events on the current thread to be processed while waiting for the
  77    * given event to be processed.
  78    */
  79   const unsigned long DISPATCH_SYNC = 1;
  80
  81   /**
  82    * Check to see if this event target is associated with the current thread.
  83    *
  84    * @returns
  85    *   A boolean value that if "true" indicates that events dispatched to this
  86    *   event target will run on the current thread (i.e., the thread calling
  87    *   this method).
  88    */
  89   boolean isOnCurrentThread();
  90 };
  91
  92 %{C++
  93 // convenient aliases:
  94 #define NS_DISPATCH_NORMAL nsIEventTarget::DISPATCH_NORMAL
  95 #define NS_DISPATCH_SYNC   nsIEventTarget::DISPATCH_SYNC
  96 %}