kotlinx.coroutines

official JetBrains project GitHub license Download

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

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.2</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.2'

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>;
}
compile "org.jetbrains.kotlinx:kotlinx-coroutines:0.20-alpha-6"

Related Libraries

korio

Korio - Kotlin cORoutines I/O - Streams + Async TCP Client/Server + WebSockets + Async Injector + Async Router + Virtual File System + Serialization (XML/Json/Yaml) + Redis + Cassandra + Elasticsearch + Amazon DynamoDB & S3 + OAuth (Google & Facebook) for JVM, Android, Node.JS and Browser

Last updated 3 mins ago

korim

Korim - Kotlin cORoutines IMaging utilities depending on Korio for JVM, Android and JS

Last updated 3 mins ago

quasar

Fibers, Channels and Actors for the JVM

Last updated 3 mins ago

kovenant

Kovenant. Promises for Kotlin.

Last updated 3 mins ago

asyncawait

async/await for Android built upon coroutines introduced in Kotlin 1.1

Last updated 3 mins ago