commit	6effdcf7c06a2b6151a81e2f27e6925ccd69aec6	[log] [tgz]
author	Denis Zharkov <denis.zharkov@jetbrains.com>	Wed Jul 06 16:15:53 2016 +0300
committer	Denis Zharkov <denis.zharkov@jetbrains.com>	Wed Jul 06 16:15:53 2016 +0300
tree	c459977455f17f246ad0edeecd1a3b80bd7ed4fb
parent	81bb04acfa16f7e2a653856f3f6d4b685917c9b2 [diff]

tree: c459977455f17f246ad0edeecd1a3b80bd7ed4fb

README.md

kotlinx.coroutines

Two libraries built upon Kotlin coroutines:

kotlinx-coroutines-async with convenient interfaces/wrappers to commonly used asynchronous API shipped with standard JDK, namely promise-like CompletableFuture and asynchronous channels from java.nio package
kotlinx-coroutines-generate provides ability to create Sequence objects generated by coroutine body containing yield suspension points

Examples

Async

import kotlinx.coroutines.async
import java.util.concurrent.CompletableFuture

private fun startLongAsyncOperation(v: Int) =
        CompletableFuture.supplyAsync {
            Thread.sleep(1000)
            "Result: $v"
        }

fun main(args: Array<String>) {
    val future = async<String> {
        (1..5).map {
            await(startLongAsyncOperation(it))
        }.joinToString("\n")
    }

    println(future.get())
}

Bear in mind that async library actively uses CompletableFuture from JDK 8, so it will not work with earlier versions.

Generate

import kotlinx.coroutines.generate

fun main(args: Array<String>) {
    val sequence = generate<Int> {
        for (i in 1..5) {
            yield(i)
        }
    }

    println(sequence.joinToString(" "))
}

For more examples you can look at kotlinx-coroutines-async-example-ui sample project or in tests directories.

Maven

Add the bintray repository

<repository>
    <snapshots>
        <enabled>false</enabled>
    </snapshots>
    <id>dl</id>
    <name>bintray</name>
    <url>http://dl.bintray.com/kotlin/kotlinx.coroutines</url>
</repository>

Add dependencies:

<dependency>
    <groupId>org.jetbrains.kotlinx</groupId>
    <artifactId>kotlinx-coroutines-generate</artifactId>
    <version>0.1-alpha-1</version>
</dependency>
<dependency>
    <groupId>org.jetbrains.kotlinx</groupId>
    <artifactId>kotlinx-coroutines-async</artifactId>
    <version>0.1-alpha-1</version>
</dependency>

Gradle

Just add dependencies:

compile 'org.jetbrains.kotlinx:kotlinx-coroutines-generate:0.1-alpha-1'
compile 'org.jetbrains.kotlinx:kotlinx-coroutines-async:0.1-alpha-1'

NB: As async library is built upon CompletableFuture it requires JDK 8 (24 Android API level)

Also you should include our bintray repository:

repositories {
    maven {
        url "http://dl.bintray.com/kotlin/kotlinx.coroutines"
    }
}