commit	47d92bafe90d899dfb53cd0f8bf7eae75504047e	[log] [tgz]
author	Sergey Mashkov <sergey.mashkov@jetbrains.com>	Fri Nov 17 19:30:22 2017 +0300
committer	Sergey Mashkov <sergey.mashkov@jetbrains.com>	Fri Nov 17 19:30:22 2017 +0300
tree	a986485f46f81cc7a38feebdef08981e7ab4c941
parent	d42bdadc8520ec490d5b37f5f160b54d4541d2f8 [diff]

tree: a986485f46f81cc7a38feebdef08981e7ab4c941

README.md

kotlinx.coroutines

Library support for Kotlin coroutines. This is a companion version for Kotlin 1.1.4 release (this is the minimal required Kotlin runtime version).

Modules

core -- core primitives to work with coroutines:
- launch, async, produce, actor, etc coroutine builders;
- Job and Deferred light-weight future with cancellation support;
- CommonPool and other coroutine contexts;
- Channel and Mutex communication and synchronization primitives;
- delay, yield, etc top-level suspending functions;
- select expression support and more.
reactive -- modules that provide builders and iteration support for various reactive streams libraries:
- Reactive Streams, RxJava 1.x and 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 synchronous networking/IO.

Documentation

Introduction to Kotlin Coroutines video (Roman Elizarov at GeekOut 2017, 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

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

And make sure that you use the latest Kotlin version:

<properties>
    <kotlin.version>1.1.51</kotlin.version>
</properties>

Gradle

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

compile 'org.jetbrains.kotlinx:kotlinx-coroutines-core:0.19.3'

And make sure that you use the latest Kotlin version:

buildscript {
    ext.kotlin_version = '1.1.51'
}

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>;
}