commit	dbe3f48f8854a7bd72019ba296acd5d676257caa	[log] [tgz]
author	Vsevolod Tolstopyatov <qwwdfsad@gmail.com>	Wed Apr 17 17:51:13 2019 +0300
committer	Vsevolod Tolstopyatov <qwwdfsad@gmail.com>	Wed Apr 17 17:51:13 2019 +0300
tree	81bd356c69fbfef1e2259908c039849daefd5245
parent	43983505033a67719b0621572b868fc55f492016 [diff]

tree: 81bd356c69fbfef1e2259908c039849daefd5245

README.md

kotlinx.coroutines

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

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

Modules

core — 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/jvm — additional core features available on Kotlin/JVM:
- Dispatchers.IO dispatcher for blocking coroutines;
- Executor.asCoroutineDispatcher() extension, custom thread pools, and more.
core/js — additional core features available on Kotlin/JS:
- Integration with Promise;
- Integration with Window.
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.
- CoroutinesTimeout test rule to automatically dump coroutines on test timeout.
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

Presentations and videos:
- Introduction to Coroutines (Roman Elizarov at KotlinConf 2017, slides)
- Deep dive into Coroutines (Roman Elizarov at KotlinConf 2017, slides)
- Kotlin Coroutines in Practice (Roman Elizarov at KotlinConf 2018, slides)
Guides and manuals:
Compatibility policy and experimental annotations
Change log for kotlinx.coroutines
Coroutines design document (KEEP)
Full kotlinx.coroutines API reference

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.2.0</version>
</dependency>

And make sure that you use the latest Kotlin version:

<properties>
    <kotlin.version>1.3.30</kotlin.version>
</properties>

Gradle

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

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

And make sure that you use the latest Kotlin version:

buildscript {
    ext.kotlin_version = '1.3.30'
}

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.2.0")
}

And make sure that you use the latest Kotlin version:

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

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 for 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.2.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.