Library support for Kotlin coroutines
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
benchmarks Do not yield in CoroutineScheduler during transition to the idle stat… Dec 12, 2018
binary-compatibility-validator EventLoop integration and reuse for runBlocking and Unconfined dispat… Dec 21, 2018
common EventLoop integration and reuse for runBlocking and Unconfined dispat… Dec 21, 2018
core More idiomatic and readable example for coroutines debug module readme Dec 22, 2018
docs Remove unnecessary function declaration from example Dec 13, 2018
gradle Merge pull request #876 from Kotlin/debug-agent Dec 13, 2018
integration replace deprecated cancel with completeExceptionally Jan 16, 2019
js EventLoop integration and reuse for runBlocking and Unconfined dispat… Dec 21, 2018
knit Introduce test module with testable main dispatcher (#749) Dec 17, 2018
license Moved license to the top for GitHub's pleasure Jun 29, 2018
native Version 1.1.0 Dec 21, 2018
reactive Make ConflatedChannel linearizable Dec 12, 2018
site Updated Jekyll version to 3.6.3 Dec 11, 2018
ui Update coroutines-guide-ui.md Jan 9, 2019
.gitignore Defined specific dependencies for android sample apps Aug 10, 2018
CHANGES.md Version 1.1.0 Dec 21, 2018
COMPATIBILITY.md Version 1.0.0 Oct 24, 2018
LICENSE.txt Moved license to the top for GitHub's pleasure Jun 29, 2018
README.md Consistently update Kotlin version everywhere Dec 21, 2018
RELEASE.md Debug agent to track alive coroutines Dec 10, 2018
build.gradle Introduce test module with testable main dispatcher (#749) Dec 17, 2018
bump-version.sh Version 1.1.0-alpha Dec 18, 2018
coroutines-guide.md Restore TOC in the root coroutines-guide.md file with links to indivi… Oct 8, 2018
gradle.properties Version 1.1.0 Dec 21, 2018
gradlew Migrate build to gradle Oct 26, 2017
gradlew.bat Migrate build to gradle Oct 26, 2017
settings.gradle Introduce test module with testable main dispatcher (#749) Dec 17, 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.3.11 release.

NOTE: 0.30.2 was the last release with Kotlin 1.2 and experimental coroutines. 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 platforms:
    • 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.
  • core — Kotlin/JVM implementation of common coroutines with additional features:
    • Dispatchers.IO dispatcher for blocking coroutines;
    • Executor.asCoroutineDispatcher() extension, custom thread pools, and more.
  • test — test utilities for coroutines
    • Dispatchers.setMain to override Dispatchers.Main in tests.
  • debug — debug utilities for coroutines.
    • DebugProbes API to probe, keep track of, print and dump active coroutines.
  • 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

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>1.1.0</version>
</dependency>

And make sure that you use the latest Kotlin version:

<properties>
    <kotlin.version>1.3.11</kotlin.version>
</properties>

Gradle

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

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

And make sure that you use the latest Kotlin version:

buildscript {
    ext.kotlin_version = '1.3.11'
}

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

repository {
    jcenter()
}

Gradle Kotlin DSL

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

dependencies {
    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.1.0")
}

And make sure that you use the latest Kotlin version:

plugins {
    kotlin("jvm") version "1.3.11"
}

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

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:1.1.0'

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.

R8 and ProGuard

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.3.0-beta.

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. It is okay to have JDK_16 pointing to JAVA_HOME for external contributions.

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.