commit	64e49dc8e57e590f992ef444dc08302da3427403	[log] [tgz]
author	Vsevolod Tolstopyatov <qwwdfsad@gmail.com>	Tue Oct 23 19:18:32 2018 +0300
committer	Vsevolod Tolstopyatov <qwwdfsad@gmail.com>	Tue Oct 23 19:18:32 2018 +0300
tree	6e310f5176a5e735ff4ad6ccc0b3e40c4292f9a0
parent	e321394c359758659a07ad1c98429ec2acd8ea59 [diff]

tree: 6e310f5176a5e735ff4ad6ccc0b3e40c4292f9a0

README.md

kotlinx.coroutines

Library support for Kotlin coroutines with multiplatform support. This is a companion version for Kotlin 1.3.0-rc-146 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 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

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:
- Guide to kotlinx.coroutines by example (read it first)
- Guide to UI programming with coroutines
- Guide to reactive streams with coroutines
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.0.0-RC1</version>
</dependency>

And make sure that you use the latest Kotlin version:

<properties>
    <kotlin.version>1.3.0-rc-146</kotlin.version>
</properties>

While Kotlin 1.3 is still in release candidate status, in order to depend on it you should add eap repository: https://dl.bintray.com/kotlin/kotlin-eap.

Gradle

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

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

And make sure that you use the latest Kotlin version:

buildscript {
    ext.kotlin_version = '1.3.0-rc-146'
}

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

And make sure that you use the latest Kotlin version:

plugins {
    kotlin("jvm") version "1.3.0-rc-146"
}

Make sure that you have either jcenter() or mavenCentral() in the list of repositories. For Kotlin EAP builds you also may need kotlin-eap repository:

repository {
    jcenter()
    maven { url "https://kotlin.bintray.com/kotlin-eap" }
}

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.0.0-RC1'

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

If you are using R8 or ProGuard add the options from coroutines.pro file to your rules.

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.