diff options
Diffstat (limited to 'kotlinx-coroutines-core/common/src/CoroutineStart.kt')
| -rw-r--r-- | kotlinx-coroutines-core/common/src/CoroutineStart.kt | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/kotlinx-coroutines-core/common/src/CoroutineStart.kt b/kotlinx-coroutines-core/common/src/CoroutineStart.kt index 6059829c..d5791c79 100644 --- a/kotlinx-coroutines-core/common/src/CoroutineStart.kt +++ b/kotlinx-coroutines-core/common/src/CoroutineStart.kt @@ -1,6 +1,7 @@ /* - * Copyright 2016-2021 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. + * Copyright 2016-2020 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. */ +@file:Suppress("NO_EXPLICIT_VISIBILITY_IN_API_MODE") package kotlinx.coroutines import kotlinx.coroutines.CoroutineStart.* @@ -58,8 +59,8 @@ public enum class CoroutineStart { ATOMIC, /** - * Immediately executes the coroutine until its first suspension point _in the current thread_ similarly to - * the coroutine being started using [Dispatchers.Unconfined]. However, when the coroutine is resumed from suspension + * Immediately executes the coroutine until its first suspension point _in the current thread_ as if the + * coroutine was started using [Dispatchers.Unconfined]. However, when the coroutine is resumed from suspension * it is dispatched according to the [CoroutineDispatcher] in its context. * * This is similar to [ATOMIC] in the sense that coroutine starts executing even if it was already cancelled, @@ -68,11 +69,9 @@ public enum class CoroutineStart { * Cancellability of coroutine at suspension points depends on the particular implementation details of * suspending functions as in [DEFAULT]. * - * ### Unconfined event loop - * - * Unlike [Dispatchers.Unconfined] and [MainCoroutineDispatcher.immediate], nested undispatched coroutines do not form - * an event loop that otherwise prevents potential stack overflow in case of unlimited nesting. + * **Note: This is an experimental api.** Execution semantics of coroutines may change in the future when this mode is used. */ + @ExperimentalCoroutinesApi // Since 1.0.0, no ETA on stability UNDISPATCHED; /** |