Library support for Kotlin coroutines. This is a companion version for Kotlin 1.1-Beta release. It contains worked-out implementation of coroutine builders, suspending functions, and contexts that are used as examples in Kotlin coroutines design document
It consists of the following modules:
kotlinx-coroutines-core
module with core primitives to work with coroutines. It is designed to work on any JDK6+ and Android and contains the following main pieces:
lanunch(context) { ... }
to start a coroutine in the given context.run(context) { ... }
to switch to a different context inside a coroutine.runBlocking(context) { ... }
to use asynchronous Kotlin APIs from a thread-blocking code.defer(context) { ... }
to get a deferred result of coroutine execution in a non-blocking way.delay(...)
for a non-blocking sleep in coroutines.Here
and CommonPool
contexts.newSingleThreadContext(...)
and newFixedThreadPoolContext(...)
functions.Job
interface and suspendCancellableCoroutine
helper function.-ea
or -Dkotlinx.coroutines.debug
options) and newCoroutineContext(context)
function to write user-defined coroutine builders that work with these debugging facilities.kotlinx-coroutines-jdk8
module with additional libraries for JDK8 (or Android API level 24).
future { ... }
coroutine builder that returns CompletableFuture
and works in CommonPool
context by default..await()
suspending function for CompletableFuture
.kotlinx-coroutines-nio
module with extensions for asynchronous IO on JDK7+ (does not support cancellation yet).
kotlinx-coroutines-swing
module with Swing
context for Swing UI applications.
kotlinx-coroutines-javafx
module with JavaFx
context for JavaFX UI applications.
kotlinx-coroutines-rx
module with utilities to build Observable
objects from RxJava with imperative coroutines and consume their values from inside coroutines. It is in very basic form now (example-only, not even close to production use)
Note that these libraries are experimental and are subject to change.
The libraries are published to kotlin-eap-1.1 bintray repository.
These libraries require kotlin compiler version to be at least 1.1-Beta
and require kotlin runtime of the same version as a dependency, which can be obtained from the same repository.
Add the bintray repository to <repositories>
section (and also add pluginRepository
to <pluginRepositories>
, if you're willing to get kotlin-maven-plugin
from there):
<repository> <snapshots> <enabled>false</enabled> </snapshots> <id>dl</id> <name>bintray</name> <url>http://dl.bintray.com/kotlin/kotlin-eap-1.1</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.3-beta</version> </dependency>
Add the bintray repository (and also add it to buildScript
section, if you're willing to get kotlin-gradle-plugin
from there):
repositories { maven { url "http://dl.bintray.com/kotlin/kotlin-eap-1.1" } }
Add dependencies (you can also add other modules that you need):
compile 'org.jetbrains.kotlinx:kotlinx-coroutines-core:0.3-beta'