commit	f724f6e2fe7c20cb48b69cd7b19b2658313231e4	[log] [tgz]
author	Roman Elizarov <elizarov@gmail.com>	Fri Apr 07 18:06:22 2017 +0300
committer	Roman Elizarov <elizarov@gmail.com>	Fri Apr 07 18:06:22 2017 +0300
tree	0e574b362bb206257195e72e588c335653d0752e
parent	ecda27fa01602e42922eadc16ef34b920b8006bb [diff]

tree: 0e574b362bb206257195e72e588c335653d0752e

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.15-SNAPSHOT</version>
</dependency>

And make sure that you use the right Kotlin version:

<properties>
    <kotlin.version>1.1.1</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.15-SNAPSHOT'

And make sure that you use the right Kotlin version:

buildscript {
    ext.kotlin_version = '1.1.1'
}