Roman Elizarov | f16fd27 | 2017-02-07 11:26:00 +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 | |
Roman Elizarov | 01934df | 2017-01-31 09:18:34 +0300 | [diff] [blame] | 17 | package kotlinx.coroutines.experimental |
| 18 | |
| 19 | import kotlinx.coroutines.experimental.NonCancellable.isActive |
Roman Elizarov | ea4a51b | 2017-01-31 12:01:25 +0300 | [diff] [blame] | 20 | import kotlin.coroutines.experimental.AbstractCoroutineContextElement |
Roman Elizarov | 01934df | 2017-01-31 09:18:34 +0300 | [diff] [blame] | 21 | |
| 22 | /** |
| 23 | * A non-cancelable job that is always [active][isActive]. It is designed to be used with [run] builder |
Roman Elizarov | b7c46de | 2017-02-08 12:35:24 +0300 | [diff] [blame^] | 24 | * to prevent cancellation of code blocks that need to run without cancellation. |
| 25 | * |
| 26 | * Use it like this: |
Roman Elizarov | 01934df | 2017-01-31 09:18:34 +0300 | [diff] [blame] | 27 | * ``` |
| 28 | * run(NonCancellable) { |
| 29 | * // this code will not be cancelled |
| 30 | * } |
| 31 | * ``` |
| 32 | */ |
| 33 | object NonCancellable : AbstractCoroutineContextElement(Job), Job { |
| 34 | override val isActive: Boolean get() = true |
Roman Elizarov | b7c46de | 2017-02-08 12:35:24 +0300 | [diff] [blame^] | 35 | override fun getCompletionException(): CancellationException = throw IllegalStateException("This job is always active") |
Roman Elizarov | 01934df | 2017-01-31 09:18:34 +0300 | [diff] [blame] | 36 | override fun onCompletion(handler: CompletionHandler): Job.Registration = EmptyRegistration |
Roman Elizarov | f6fed2a | 2017-02-03 19:12:09 +0300 | [diff] [blame] | 37 | override fun cancel(cause: Throwable?): Boolean = false |
Roman Elizarov | 01934df | 2017-01-31 09:18:34 +0300 | [diff] [blame] | 38 | } |