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/. */
7 #include
"nsISupports.idl"
12 * Handle for the ongoing shutdown progress of a given thread which can be used
13 * to observe and interrupt async shutdown progress. Methods on this interface
14 * may generally only be used on the thread which called
15 * `nsIThread::beginShutdown`.
17 [scriptable
, builtinclass
, uuid(70a43748
-6130-4ea6
-a440
-7c74e1b7dd7c
)]
18 interface nsIThreadShutdown
: nsISupports
21 * Register a runnable to be executed when the thread has completed shutdown,
22 * or shutdown has been cancelled due to `stopWaitingAndLeakThread()`.
24 * If the thread has already completed or cancelled shutdown, the runnable
25 * may be executed synchronously.
27 * May only be called on the thread which invoked `nsIThread::beginShutdown`.
29 void onCompletion
(in nsIRunnable aEvent
);
32 * Check if the target thread has completed shutdown.
34 * May only be accessed on the thread which called `nsIThread::beginShutdown`.
36 [infallible
] readonly attribute
boolean completed
;
39 * Give up on waiting for the shutting down thread to exit. Calling this
40 * method will allow the thread to continue running, no longer block shutdown,
41 * and the thread will never be joined or have its resources reclaimed.
43 * Completion callbacks attached to this `nsIThreadShutdown` may be executed
46 * This method should NOT be called except in exceptional circumstances during
47 * shutdown, as it will cause resources for the shutting down thread to be
50 * May only be called on the thread which called `nsIThread::beginShutdown`
52 * @throws NS_ERROR_NOT_AVAILABLE
53 * Indicates that the target thread has already stopped running and a
54 * request to be joined is already being dispatched to the waiting thread.
56 void stopWaitingAndLeakThread
();