commit	eab2cffa1bc568cba952754c0f3188620f7c892d	[log] [tgz]
author	Roman Elizarov <elizarov@gmail.com>	Fri Jul 21 19:07:17 2017 +0300
committer	Roman Elizarov <elizarov@gmail.com>	Fri Jul 21 19:07:17 2017 +0300
tree	a84da9361e8e7a4b28736fc4c5691a00b2d5b52c
parent	fe64d7bbced55dc43adf377a84adebbe626ea090 [diff]

tree: a84da9361e8e7a4b28736fc4c5691a00b2d5b52c

README.md

kotlinx.coroutines

Library support for Kotlin coroutines. This is a companion version for Kotlin 1.1 release.

Modules

kotlinx-coroutines-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 and also linked to JCenter.

These libraries require kotlin compiler version 1.1.x 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.16</version>
</dependency>

And make sure that you use the right Kotlin version:

<properties>
    <kotlin.version>1.1.2</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.16'

And make sure that you use the right Kotlin version:

buildscript {
    ext.kotlin_version = '1.1.2'
}