Library support for Kotlin coroutines
Permalink
Failed to load latest commit information.
benchmarks Benchmarks improvements: Sep 20, 2018
binary-compatibility-validator Move UI dispatcher to common Dispatchers.Main (#641) Oct 1, 2018
common Fix lost exception from dispatched withContext on cancelled job Oct 8, 2018
core Restore TOC in the root coroutines-guide.md file with links to indivi… Oct 8, 2018
docs Update exception-handling.md Oct 12, 2018
gradle Run JS tests on transformed kotlinx-coroutines-core-js module files Oct 8, 2018
integration Deprecate ReceiveChannel<T>.collect Oct 8, 2018
js Lazily load Dispatchers.Main and provide a stub impl on failure Oct 8, 2018
knit Restore TOC in the root coroutines-guide.md file with links to indivi… Oct 8, 2018
license Moved license to the top for GitHub's pleasure Jun 29, 2018
native Version 0.30.2 Oct 8, 2018
reactive Coroutine scheduler is used by default instead of deprecated CommonPool Sep 28, 2018
site Integration module for Play Services Tasks API. Sep 24, 2018
ui Version 0.30.2 Oct 8, 2018
.gitignore Defined specific dependencies for android sample apps Aug 10, 2018
CHANGES.md Version 0.30.2 Oct 8, 2018
COMPATIBILITY.md Version 0.30.2 Oct 8, 2018
LICENSE.txt Moved license to the top for GitHub's pleasure Jun 29, 2018
README.md Cleaned up top-level readme a bit (removed outdated things) Oct 10, 2018
RELEASE.md Version 0.30.0 Sep 28, 2018
build.gradle Introduce ThreadContextElement API to integrate with thread-local sen… Aug 23, 2018
bump-version.sh Version 0.30.2 Oct 8, 2018
coroutines-guide.md Restore TOC in the root coroutines-guide.md file with links to indivi… Oct 8, 2018
gradle.properties Version 0.30.2 Oct 8, 2018
gradlew Migrate build to gradle Oct 26, 2017
gradlew.bat Migrate build to gradle Oct 26, 2017
settings.gradle Integration module for Play Services Tasks API. Sep 24, 2018

README.md

kotlinx.coroutines

official JetBrains project GitHub license Download

Library support for Kotlin coroutines with multiplatform support. This is a companion version for Kotlin 1.2.70 release.

NOTE: This is the last experimental feature release. See COMPATIBILITY.md for details of migration onto the stable Kotlin 1.3 coroutines.

GlobalScope.launch {
    delay(1000)
    println("Hello from Kotlin Coroutines!")
}

Modules

  • common — common coroutines across all backends:
    • launch and async coroutine builders;
    • Job and Deferred light-weight future with cancellation support;
    • 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.
  • core — Kotlin/JVM implementation of common coroutines with additional features:
    • Dispatchers.IO dispatcher for blocking coroutines;
    • Executor.asCoroutineDispatcher() extension, custom thread pools, and more.
  • js — Kotlin/JS implementation of common coroutines with Promise support.
  • native — Kotlin/Native implementation of common coroutines with runBlocking single-threaded event loop.
  • reactive — modules that provide builders and iteration support for various reactive streams libraries:
    • Reactive Streams, RxJava 2.x, and Project Reactor.
  • ui — modules that provide coroutine dispatchers for various single-threaded UI libraries:
    • Android, JavaFX, and Swing.
  • integration — modules that provide integration with various asynchronous callback- and future-based libraries.
    • JDK8 CompletableFuture, Guava ListenableFuture, and Google Play Services Task;
    • SLF4J MDC integration via MDCContext.

Documentation

Using in your projects

Note that these libraries are experimental and are subject to change.

The libraries are published to kotlinx bintray repository, linked to JCenter and pushed to Maven Central.

Maven

Add dependencies (you can also add other modules that you need):

<dependency>
    <groupId>org.jetbrains.kotlinx</groupId>
    <artifactId>kotlinx-coroutines-core</artifactId>
    <version>0.30.2</version>
</dependency>

And make sure that you use the latest Kotlin version:

<properties>
    <kotlin.version>1.2.70</kotlin.version>
</properties>

Gradle

Add dependencies (you can also add other modules that you need):

dependencies {
    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:0.30.2'
}

And make sure that you use the latest Kotlin version:

buildscript {
    ext.kotlin_version = '1.2.70'
}

Make sure that you have either jcenter() or mavenCentral() in the list of repositories:

repository {
    jcenter()
}

Multiplatform

Core modules of kotlinx.coroutines are also available for Kotlin/JS and Kotlin/Native. If you write a common code that should get compiled or different platforms, add org.jetbrains.kotlinx:kotlinx-coroutines-core-common:<version> to your common code dependencies.

Android

Add kotlinx-coroutines-android module as dependency when using kotlinx.coroutines on Android:

implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:0.30.2'

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.

ProGuard

In obfuscated code, fields with different types can have the same names, and AtomicReferenceFieldUpdater may be unable to find the correct ones. To avoid field overloading by type during obfuscation, add this to your config:

-keepclassmembernames class kotlinx.** {
    volatile <fields>;
}

Building

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)

Requirements

  • JDK >= 1.8 referred to by the JAVA_HOME environment variable.
  • JDK 1.6 referred to by the JDK_16 environment variable.

Contributions and releases

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.

  • Full release procedure checklist is here.
  • Steps for contributing new integration modules are explained here.