shutdown() method moved to common Dispatchers

Kotlin · Apr 19, 2021 · 0358568 · 0358568
1 parent e51fd5c
commit 0358568
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 2 deletions.
diff --git a/kotlinx-coroutines-core/common/src/Dispatchers.common.kt b/kotlinx-coroutines-core/common/src/Dispatchers.common.kt
@@ -78,4 +78,14 @@ public expect object Dispatchers {
      * the value of [CoroutineStart.UNDISPATCHED].
      */
     public val Unconfined: CoroutineDispatcher
+
+    /**
+     * Shuts down the dispatcher.
+     *
+     * Its implementation depends on the platform:
+     * - On Kotlin/JVM and Kotlin/JS takes no effect.
+     * - On Kotlin/Native requests termination of the worker created by the [Default] dispatcher.
+     */
+    @ExperimentalCoroutinesApi
+    public fun CoroutineDispatcher.shutdown()
 }
diff --git a/kotlinx-coroutines-core/js/src/Dispatchers.kt b/kotlinx-coroutines-core/js/src/Dispatchers.kt
@@ -10,6 +10,7 @@ public actual object Dispatchers {
     public actual val Default: CoroutineDispatcher = createDefaultDispatcher()
     public actual val Main: MainCoroutineDispatcher = JsMainDispatcher(Default, false)
     public actual val Unconfined: CoroutineDispatcher = kotlinx.coroutines.Unconfined
+    public actual fun CoroutineDispatcher.shutdown() {}
 }
 
 private class JsMainDispatcher(

diff --git a/kotlinx-coroutines-core/jvm/src/Dispatchers.kt b/kotlinx-coroutines-core/jvm/src/Dispatchers.kt
@@ -115,4 +115,6 @@ public actual object Dispatchers {
      */
     @JvmStatic
     public val IO: CoroutineDispatcher = DefaultScheduler.IO
+
+    public actual fun CoroutineDispatcher.shutdown() {}
 }
diff --git a/kotlinx-coroutines-core/native/src/Dispatchers.native.kt b/kotlinx-coroutines-core/native/src/Dispatchers.native.kt
@@ -13,8 +13,7 @@ public actual object Dispatchers {
     public actual val Main: MainCoroutineDispatcher = createMainDispatcher(Default)
     public actual val Unconfined: CoroutineDispatcher get() = kotlinx.coroutines.Unconfined // Avoid freezing
 
-    @ExperimentalCoroutinesApi
-    public fun CoroutineDispatcher.shutdown() {
+    public actual fun CoroutineDispatcher.shutdown() {
         if (this === DefaultDispatcher) shutdown()
     }
 }