summaryrefslogtreecommitdiffstats
path: root/xpcom/threads/nsIThreadShutdown.idl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
commit36d22d82aa202bb199967e9512281e9a53db42c9 (patch)
tree105e8c98ddea1c1e4784a60a5a6410fa416be2de /xpcom/threads/nsIThreadShutdown.idl
parentInitial commit. (diff)
downloadfirefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz
firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip
Adding upstream version 115.7.0esr.upstream/115.7.0esrupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'xpcom/threads/nsIThreadShutdown.idl')
-rw-r--r--xpcom/threads/nsIThreadShutdown.idl57
1 files changed, 57 insertions, 0 deletions
diff --git a/xpcom/threads/nsIThreadShutdown.idl b/xpcom/threads/nsIThreadShutdown.idl
new file mode 100644
index 0000000000..a08d64165b
--- /dev/null
+++ b/xpcom/threads/nsIThreadShutdown.idl
@@ -0,0 +1,57 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim:set ts=2 sw=2 sts=2 et cindent: */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#include "nsISupports.idl"
+
+interface nsIRunnable;
+
+/**
+ * Handle for the ongoing shutdown progress of a given thread which can be used
+ * to observe and interrupt async shutdown progress. Methods on this interface
+ * may generally only be used on the thread which called
+ * `nsIThread::beginShutdown`.
+ */
+[scriptable, builtinclass, uuid(70a43748-6130-4ea6-a440-7c74e1b7dd7c)]
+interface nsIThreadShutdown : nsISupports
+{
+ /**
+ * Register a runnable to be executed when the thread has completed shutdown,
+ * or shutdown has been cancelled due to `stopWaitingAndLeakThread()`.
+ *
+ * If the thread has already completed or cancelled shutdown, the runnable
+ * may be executed synchronously.
+ *
+ * May only be called on the thread which invoked `nsIThread::beginShutdown`.
+ */
+ void onCompletion(in nsIRunnable aEvent);
+
+ /**
+ * Check if the target thread has completed shutdown.
+ *
+ * May only be accessed on the thread which called `nsIThread::beginShutdown`.
+ */
+ [infallible] readonly attribute boolean completed;
+
+ /**
+ * Give up on waiting for the shutting down thread to exit. Calling this
+ * method will allow the thread to continue running, no longer block shutdown,
+ * and the thread will never be joined or have its resources reclaimed.
+ *
+ * Completion callbacks attached to this `nsIThreadShutdown` may be executed
+ * during this call.
+ *
+ * This method should NOT be called except in exceptional circumstances during
+ * shutdown, as it will cause resources for the shutting down thread to be
+ * leaked.
+ *
+ * May only be called on the thread which called `nsIThread::beginShutdown`
+ *
+ * @throws NS_ERROR_NOT_AVAILABLE
+ * Indicates that the target thread has already stopped running and a
+ * request to be joined is already being dispatched to the waiting thread.
+ */
+ void stopWaitingAndLeakThread();
+};