Roman Elizarov | aa461cf | 2018-04-11 13:20:29 +0300 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016-2017 JetBrains s.r.o. |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package kotlinx.coroutines.experimental |
| 18 | |
| 19 | import kotlin.coroutines.experimental.* |
| 20 | |
| 21 | /** |
| 22 | * A coroutine dispatcher that is not confined to any specific thread. |
| 23 | * It executes initial continuation of the coroutine _right here_ in the current call-frame |
| 24 | * and let the coroutine resume in whatever thread that is used by the corresponding suspending function, without |
| 25 | * mandating any specific threading policy. |
| 26 | * |
| 27 | * Note, that if you need your coroutine to be confined to a particular thread or a thread-pool after resumption, |
| 28 | * but still want to execute it in the current call-frame until its first suspension, then you can use |
| 29 | * an optional [CoroutineStart] parameter in coroutine builders like [launch] and [async] setting it to the |
| 30 | * the value of [CoroutineStart.UNDISPATCHED]. |
| 31 | */ |
| 32 | public object Unconfined : CoroutineDispatcher() { |
| 33 | override fun isDispatchNeeded(context: CoroutineContext): Boolean = false |
| 34 | override fun dispatch(context: CoroutineContext, block: Runnable) { throw UnsupportedOperationException() } |
| 35 | override fun toString(): String = "Unconfined" |
| 36 | } |