Core primitives to work with coroutines.
This module provides the following coroutine builders:
| Name | Result | Scope | Description |
|---|---|---|---|
| launch | Job | CoroutineScope | Launches coroutine that does not have any result |
| async | Deferred | CoroutineScope | Returns a single value with the future result |
| produce | ProducerJob | ProducerScope | Produces a stream of elements |
| runBlocking | T | CoroutineScope | Blocks the thread while the coroutine runs |
These builders can be used with the following coroutine dispatchers:
| Name | Description |
|---|---|
| CommonPool | Confines coroutine execution to a shared pool of threads |
| newSingleThreadContext | Create new single-threaded coroutine context |
| newFixedThreadPoolContext | Creates new thread pool of a fixed size |
| Executor.toCoroutineDispatcher | Extension to convert any executor |
| Unconfined | Does not confine coroutine execution in any way |
The following top-level suspending functions are provided to be used inside coroutines:
| Name | Description |
|---|---|
| delay | Non-blocking sleep |
| yield | Yields thread in single-threaded dispatchers |
| run | Switches to a different context |
| withTimeout | Set execution time-limit (deadline) |
Cancellation support for user-defined suspending functions is available with suspendCancellableCoroutine helper function. NonCancellable job object is provided to suppress cancellation with run(NonCancellable) {...} block of code.
This module provides debugging facilities for coroutines (run JVM with -ea or -Dkotlinx.coroutines.debug options) and newCoroutineContext function to write user-defined coroutine builders that work with these debugging facilities.
General-purpose coroutine builders, contexts, and helper functions.
Channels -- non-blocking primitives for communicating a stream of elements between coroutines.