netwerk/base/public/nsICancelable.idl

Thu, 22 Jan 2015 13:21:57 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 22 Jan 2015 13:21:57 +0100
branch
TOR_BUG_9701
changeset 15
b8a032363ba2
permissions
-rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

michael@0 1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
michael@0 2 /* vim:set ts=2 sw=2 sts=2 et cindent: */
michael@0 3 /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0 4 * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0 5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0 6
michael@0 7 #include "nsISupports.idl"
michael@0 8
michael@0 9 /**
michael@0 10 * This interface provides a means to cancel an operation that is in progress.
michael@0 11 */
michael@0 12 [scriptable, uuid(d94ac0a0-bb18-46b8-844e-84159064b0bd)]
michael@0 13 interface nsICancelable : nsISupports
michael@0 14 {
michael@0 15 /**
michael@0 16 * Call this method to request that this object abort whatever operation it
michael@0 17 * may be performing.
michael@0 18 *
michael@0 19 * @param aReason
michael@0 20 * Pass a failure code to indicate the reason why this operation is
michael@0 21 * being canceled. It is an error to pass a success code.
michael@0 22 */
michael@0 23 void cancel(in nsresult aReason);
michael@0 24 };

mercurial