• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1[//]: # (title: Coroutines guide)
2
3Kotlin provides only minimal low-level APIs in its standard library to enable other
4libraries to utilize coroutines. Unlike many other languages with similar capabilities, `async` and `await`
5are not keywords in Kotlin and are not even part of its standard library. Moreover, Kotlin's concept
6of _suspending function_ provides a safer and less error-prone abstraction for asynchronous
7operations than futures and promises.
8
9`kotlinx.coroutines` is a rich library for coroutines developed by JetBrains. It contains a number of high-level
10coroutine-enabled primitives that this guide covers, including `launch`, `async`, and others.
11
12This is a guide about the core features of `kotlinx.coroutines` with a series of examples, divided up into different topics.
13
14In order to use coroutines as well as follow the examples in this guide, you need to add a dependency on the `kotlinx-coroutines-core` module as explained
15[in the project README](https://github.com/Kotlin/kotlinx.coroutines/blob/master/README.md#using-in-your-projects).
16
17## Table of contents
18
19* [Coroutines basics](coroutines-basics.md)
20* [Hands-on: Intro to coroutines and channels](https://play.kotlinlang.org/hands-on/Introduction%20to%20Coroutines%20and%20Channels)
21* [Cancellation and timeouts](cancellation-and-timeouts.md)
22* [Composing suspending functions](composing-suspending-functions.md)
23* [Coroutine context and dispatchers](coroutine-context-and-dispatchers.md)
24* [Asynchronous Flow](flow.md)
25* [Channels](channels.md)
26* [Coroutine exceptions handling](exception-handling.md)
27* [Shared mutable state and concurrency](shared-mutable-state-and-concurrency.md)
28* [Select expression (experimental)](select-expression.md)
29* [Tutorial: Debug coroutines using IntelliJ IDEA](debug-coroutines-with-idea.md)
30* [Tutorial: Debug Kotlin Flow using IntelliJ IDEA](debug-flow-with-idea.md)
31
32## Additional references
33
34* [Guide to UI programming with coroutines](https://github.com/Kotlin/kotlinx.coroutines/blob/master/ui/coroutines-guide-ui.md)
35* [Coroutines design document (KEEP)](https://github.com/Kotlin/KEEP/blob/master/proposals/coroutines.md)
36* [Full kotlinx.coroutines API reference](https://kotlinlang.org/api/kotlinx.coroutines/)
37* [Best practices for coroutines in Android](https://developer.android.com/kotlin/coroutines/coroutines-best-practices)
38* [Additional Android resources for Kotlin coroutines and flow](https://developer.android.com/kotlin/coroutines/additional-resources)
39