Git Product home page Git Product logo

kotlinx.coroutines's Introduction

kotlinx.coroutines

official JetBrains project GitHub license Download

Library support for Kotlin coroutines. This is a companion version for Kotlin 1.1.4 release (this is the minimal required Kotlin runtime version).

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.4 or later 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.18</version>
</dependency>

And make sure that you use the right Kotlin version:

<properties>
    <kotlin.version>1.1.4</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.18'

And make sure that you use the right Kotlin version:

buildscript {
    ext.kotlin_version = '1.1.4'
}

ProGuard

In obfuscated code, fields with different types can have the same names, and AtomicReferenceFieldUpdater may be unable to find the correct ones. To avoid field overloading by type during obfuscation, add this to your config:

-keepclassmembernames class kotlinx.** {
    volatile <fields>;
}

kotlinx.coroutines's People

Contributors

elizarov avatar dzharkov avatar ilya-g avatar konrad-kaminski avatar cypressious avatar erokhins avatar uchuhimo avatar shifujun avatar jakiejj avatar belovrv avatar tairrzayev avatar cy6ergn0m avatar rhencke avatar mkobit avatar miha-x64 avatar louiscad avatar hhariri avatar fvasco avatar cbeust avatar soywiz avatar gildor avatar

Watchers

amit handa avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.