xpcom/threads/nsICancelableRunnable.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

     1 /* -*- Mode: C++; tab-width: 2; 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/. */
     6 #include "nsIRunnable.idl"
     8 /**
     9  * Represents a task which can be dispatched to a thread for execution and
    10  * which can be cancelled if necessary.
    11  */
    13 [scriptable, uuid(de93dc4c-5eea-4eb7-b6d1-dbf1e0cef65c)]
    14 interface nsICancelableRunnable : nsIRunnable
    15 {
    16     /**
    17      * Cancels a pending task.  If the task has already been executed this will
    18      * be a no-op.  Calling this method twice is considered an error.
    19      *
    20      * @throws NS_ERROR_UNEXPECTED
    21      *   Indicates that the runnable has already been canceled.
    22      */
    23     void cancel();
    24 };

mercurial