netwerk/base/nsIForcePendingChannel.idl

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 #include "nsISupports.idl"
   6
   7 /**
   8  * nsIForcePending interface exposes a function that enables overwriting of the normal
   9  * behavior for the channel's IsPending(), forcing 'true' to be returned.
  10  */
  11
  12 [uuid(2ac3e1ca-049f-44c3-a519-f0681f51e9b1)]
  13 interface nsIForcePendingChannel : nsISupports
  14 {
  15
  16     /**
  17      * forcePending(true) overrides the normal behavior for the
  18      * channel's IsPending(), forcing 'true' to be returned. A call to
  19      * forcePending(false) reverts IsPending() back to normal behavior.
  20      */
  21     void forcePending(in boolean aForcePending);
  22 };