netwerk/base/nsICancelable.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 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "nsISupports.idl"
   8
   9 /**
  10  * This interface provides a means to cancel an operation that is in progress.
  11  */
  12 [scriptable, uuid(d94ac0a0-bb18-46b8-844e-84159064b0bd)]
  13 interface nsICancelable : nsISupports
  14 {
  15   /**
  16    * Call this method to request that this object abort whatever operation it
  17    * may be performing.
  18    *
  19    * @param aReason
  20    *        Pass a failure code to indicate the reason why this operation is
  21    *        being canceled.  It is an error to pass a success code.
  22    */
  23   void cancel(in nsresult aReason);
  24 };