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
- kotlinx-coroutines-core -- core primitives to work with coroutines:
launch
,async
,produce
,actor
, etc coroutine builders;Job
andDeferred
light-weight future with cancellation support;CommonPool
and other coroutine contexts;Channel
andMutex
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
, GuavaListenableFuture
, and synchronous networking/IO.
- JDK8
Documentation
- Introduction to Kotlin Coroutines video (Roman Elizarov at GeekOut 2017, slides)
- Guides and manuals:
- 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 and also linked to JCenter.
These libraries require kotlin compiler version 1.1.4
or later and
require kotlin runtime of the same version as a dependency.
Maven
Add Bintray JCenter repository to <repositories>
section:
<repository>
<id>central</id>
<url>http://jcenter.bintray.com</url>
</repository>
Add dependencies (you can also add other modules that you need):
<dependency>
<groupId>org.jetbrains.kotlinx</groupId>
<artifactId>kotlinx-coroutines-core</artifactId>
<version>0.18</version>
</dependency>
And make sure that you use the right Kotlin version:
<properties>
<kotlin.version>1.1.4</kotlin.version>
</properties>
Gradle
Add Bintray JCenter repository:
repositories {
jcenter()
}
Add dependencies (you can also add other modules that you need):
compile 'org.jetbrains.kotlinx:kotlinx-coroutines-core:0.18'
And make sure that you use the right Kotlin version:
buildscript {
ext.kotlin_version = '1.1.4'
}
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>;
}