netwerk/base/nsIRequestObserverProxy.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsIRequestObserver.idl"
   7
   8 interface nsIEventTarget;
   9
  10 /**
  11  * A request observer proxy is used to ship data over to another thread
  12  * specified by the thread's dispatch target. The "true" request observer's
  13  * methods are invoked on the other thread.
  14  *
  15  * This interface only provides the initialization needed after construction.
  16  * Otherwise, these objects are used simply as nsIRequestObserver's.
  17  */
  18 [scriptable, uuid(c2b06151-1bf8-4eef-aea9-1532f12f5a10)]
  19 interface nsIRequestObserverProxy : nsIRequestObserver
  20 {
  21     /**
  22      * Initializes an nsIRequestObserverProxy.
  23      *
  24      * @param observer - receives observer notifications on the main thread
  25      * @param context  - the context argument that will be passed to OnStopRequest
  26      *                   and OnStartRequest. This has to be stored permanently on
  27      *                   initialization because it sometimes can't be
  28      *                   AddRef/Release'd off-main-thread.
  29      */
  30     void init(in nsIRequestObserver observer, in nsISupports context);
  31 };