commit	8385ec91a90ae080c2fc2de4c918df8879ab350b	[log] [tgz]
author	Roman Elizarov <elizarov@gmail.com>	Thu May 11 18:32:52 2017 +0300
committer	Roman Elizarov <elizarov@gmail.com>	Thu May 11 18:32:52 2017 +0300
tree	f16f8e8a2e03aaaa3d2600e1926f29f40e1071a7
parent	4f69102e6aaf24b41a3c59347743b9c837a50a71 [diff]

tree: f16f8e8a2e03aaaa3d2600e1926f29f40e1071a7

README.md

kotlinx.coroutines

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

Modules

Basic modules:

kotlinx-coroutines-core -- core primitives to work with coroutines.
kotlinx-coroutines-jdk8 -- additional libraries for JDK8 (or Android API level 24).
kotlinx-coroutines-nio -- extensions for asynchronous IO on JDK7+.

Modules that provide builders and iteration support for various reactive streams libraries:

kotlinx-coroutines-reactive -- utilities for Reactive Streams
kotlinx-coroutines-reactor -- utilities for Reactor
kotlinx-coroutines-rx1 -- utilities for RxJava 1.x
kotlinx-coroutines-rx2 -- utilities for RxJava 2.x

Modules that provide coroutine dispatchers for various single-threaded UI libraries:

kotlinx-coroutines-android -- UI context for Android applications.
kotlinx-coroutines-javafx -- JavaFx context for JavaFX UI applications.
kotlinx-coroutines-swing -- Swing context for Swing UI applications.

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