xpcom/threads/nsICancelableRunnable.idl

changeset 0
6474c204b198
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/xpcom/threads/nsICancelableRunnable.idl	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,24 @@
     1.4 +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
     1.5 +/* This Source Code Form is subject to the terms of the Mozilla Public
     1.6 + * License, v. 2.0. If a copy of the MPL was not distributed with this
     1.7 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
     1.8 +
     1.9 +#include "nsIRunnable.idl"
    1.10 +
    1.11 +/**
    1.12 + * Represents a task which can be dispatched to a thread for execution and
    1.13 + * which can be cancelled if necessary.
    1.14 + */
    1.15 +
    1.16 +[scriptable, uuid(de93dc4c-5eea-4eb7-b6d1-dbf1e0cef65c)]
    1.17 +interface nsICancelableRunnable : nsIRunnable
    1.18 +{
    1.19 +    /**
    1.20 +     * Cancels a pending task.  If the task has already been executed this will
    1.21 +     * be a no-op.  Calling this method twice is considered an error.
    1.22 +     *
    1.23 +     * @throws NS_ERROR_UNEXPECTED
    1.24 +     *   Indicates that the runnable has already been canceled.
    1.25 +     */
    1.26 +    void cancel();
    1.27 +};

mercurial