xpcom/threads/nsICancelableRunnable.idl@deefc01c0e14 (annotated)
xpcom/threads/nsICancelableRunnable.idl
Thu, 15 Jan 2015 21:03:48 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 15 Jan 2015 21:03:48 +0100
- branch
- TOR_BUG_9701
- changeset 11
- deefc01c0e14
- permissions
- -rw-r--r--
Integrate friendly tips from Tor colleagues to make (or not) 4.5 alpha 3;
This includes removal of overloaded (but unused) methods, and addition of
a overlooked call to DataStruct::SetData(nsISupports, uint32_t, bool.)
| michael@0 | 1 | /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ |
| michael@0 | 2 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 3 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 4 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 5 | |
| michael@0 | 6 | #include "nsIRunnable.idl" |
| michael@0 | 7 | |
| michael@0 | 8 | /** |
| michael@0 | 9 | * Represents a task which can be dispatched to a thread for execution and |
| michael@0 | 10 | * which can be cancelled if necessary. |
| michael@0 | 11 | */ |
| michael@0 | 12 | |
| michael@0 | 13 | [scriptable, uuid(de93dc4c-5eea-4eb7-b6d1-dbf1e0cef65c)] |
| michael@0 | 14 | interface nsICancelableRunnable : nsIRunnable |
| michael@0 | 15 | { |
| michael@0 | 16 | /** |
| michael@0 | 17 | * Cancels a pending task. If the task has already been executed this will |
| michael@0 | 18 | * be a no-op. Calling this method twice is considered an error. |
| michael@0 | 19 | * |
| michael@0 | 20 | * @throws NS_ERROR_UNEXPECTED |
| michael@0 | 21 | * Indicates that the runnable has already been canceled. |
| michael@0 | 22 | */ |
| michael@0 | 23 | void cancel(); |
| michael@0 | 24 | }; |
