Library support for Kotlin coroutines with multiplatform support. This is a companion version for Kotlin 1.3.40
release.
suspend fun main() = coroutineScope { launch { delay(1000) println("Kotlin Coroutines World!") } println("Hello") }
Play with coroutines online here
launch
and async
coroutine builders;Job
and Deferred
light-weight future with cancellation support;MainScope
for Android and UI applications.Dispatchers
object with Main
dispatcher for Android/Swing/JavaFx, and Default
dispatcher for background coroutines;delay
and yield
top-level suspending functions;Channel
and Mutex
communication and synchronization primitives;coroutineScope
and supervisorScope
scope builders;SupervisorJob
and CoroutineExceptionHandler
for supervision of coroutines hierarchies;select
expression support and more.Dispatchers.IO
dispatcher for blocking coroutines;Executor.asCoroutineDispatcher()
extension, custom thread pools, and more.Promise
;Window
.Dispatchers.setMain
to override Dispatchers.Main
in tests.TestCoroutineScope
to test suspending functions and coroutines.DebugProbes
API to probe, keep track of, print and dump active coroutines.CoroutinesTimeout
test rule to automatically dump coroutines on test timeout.CompletableFuture
, Guava ListenableFuture
, and Google Play Services Task
;MDCContext
.The libraries are published to kotlinx bintray repository, linked to JCenter and pushed to Maven Central.
Add dependencies (you can also add other modules that you need):
<dependency> <groupId>org.jetbrains.kotlinx</groupId> <artifactId>kotlinx-coroutines-core</artifactId> <version>1.3.0-M1</version> </dependency>
And make sure that you use the latest Kotlin version:
<properties> <kotlin.version>1.3.40</kotlin.version> </properties>
Add dependencies (you can also add other modules that you need):
dependencies { implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.0-M1' }
And make sure that you use the latest Kotlin version:
buildscript { ext.kotlin_version = '1.3.40' }
Make sure that you have either jcenter()
or mavenCentral()
in the list of repositories:
repository { jcenter() }
Add dependencies (you can also add other modules that you need):
dependencies { implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.0-M1") }
And make sure that you use the latest Kotlin version:
plugins { kotlin("jvm") version "1.3.40" }
Make sure that you have either jcenter()
or mavenCentral()
in the list of repositories.
Core modules of kotlinx.coroutines
are also available for Kotlin/JS and Kotlin/Native. In common code that should get compiled for different platforms, add dependency tokotlinx-coroutines-core-common
(follow the link to get the dependency declaration snippet).
Add kotlinx-coroutines-android
module as dependency when using kotlinx.coroutines
on Android:
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.0-M1'
This gives you access to Android Dispatchers.Main coroutine dispatcher and also makes sure that in case of crashed coroutine with unhandled exception this exception is logged before crashing Android application, similarly to the way uncaught exceptions in threads are handled by Android runtime.
For R8 no actions required, it will take obfuscation rules from the jar.
For Proguard you need to add options from coroutines.pro to your rules manually.
R8 is a replacement for ProGuard in Android ecosystem, it is enabled by default since Android gradle plugin 3.4.0 (3.3.0-beta also had it enabled).
Kotlin/JS version of kotlinx.coroutines
is published as kotlinx-coroutines-core-js
(follow the link to get the dependency declaration snippet).
You can also use kotlinx-coroutines-core
package via NPM.
Kotlin/Native version of kotlinx.coroutines
is published as kotlinx-coroutines-core-native
(follow the link to get the dependency declaration snippet).
Only single-threaded code (JS-style) on Kotlin/Native is currently supported. Kotlin/Native supports only Gradle version 4.10 and you need to enable Gradle metadata in your settings.gradle
file:
enableFeaturePreview('GRADLE_METADATA')
Since Kotlin/Native does not generally provide binary compatibility between versions, you should use the same version of Kotlin/Native compiler as was used to build kotlinx.coroutines
.
This library is built with Gradle. To build it, use ./gradlew build
. You can import this project into IDEA, but you have to delegate build actions to Gradle (in Preferences -> Build, Execution, Deployment -> Build Tools -> Gradle -> Runner)
JAVA_HOME
environment variable.JDK_16
environment variable. It is okay to have JDK_16
pointing to JAVA_HOME
for external contributions.All development (both new features and bug fixes) is performed in develop
branch. This way master
sources always contain sources of the most recently released version. Please send PRs with bug fixes to develop
branch. Fixes to documentation in markdown files are an exception to this rule. They are updated directly in master
.
The develop
branch is pushed to master
during release.