Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / kotlinx.coroutines / 365127652d9507a72344703053bf87ad298d228f
commit365127652d9507a72344703053bf87ad298d228f[log] [tgz]
authordkhalanskyjb <52952525+dkhalanskyjb@users.noreply.github.com>Fri Feb 21 17:31:05 2020 +0300
committerGitHub <noreply@github.com>Fri Feb 21 17:31:05 2020 +0300
treea17cb5122db48583d0dabb3dd0f886e59a0c6b29
parent6d1a6e36e799db8ccc1dce2a252cc7fb16065656 [diff]
Make publication validator part of the project (#1820)

Before, publication validator was just lying nearby, in these
files, and built and run separately. Now, it is compiled
alongside the main project (in the `test` gradle configuration), so
its breakage will be detected during normal usage. Still, it is
only run when a special gradle property, `DeployVersion`, is
defined.
11 files changed
tree: a17cb5122db48583d0dabb3dd0f886e59a0c6b29
  1. benchmarks/
  2. docs/
  3. gradle/
  4. integration/
  5. js/
  6. kotlinx-coroutines-bom/
  7. kotlinx-coroutines-core/
  8. kotlinx-coroutines-debug/
  9. kotlinx-coroutines-test/
  10. license/
  11. publication-validator/
  12. reactive/
  13. site/
  14. stdlib-stubs/
  15. ui/
  16. .gitignore
  17. build.gradle
  18. bump-version.sh
  19. CHANGES.md
  20. CODE_OF_CONDUCT.md
  21. coroutines-guide.md
  22. gradle.properties
  23. gradlew
  24. gradlew.bat
  25. LICENSE.txt
  26. README.md
  27. RELEASE.md
  28. settings.gradle
README.md

kotlinx.coroutines

official JetBrains project GitHub license Download

Library support for Kotlin coroutines with multiplatform support. This is a companion version for Kotlin 1.3.61 release.

suspend fun main() = coroutineScope {
    launch { 
       delay(1000)
       println("Kotlin Coroutines World!") 
    }
    println("Hello")
}

Play with coroutines online here

Modules

Documentation

Using in your projects

The libraries are published to kotlinx bintray repository, linked to JCenter and pushed to Maven Central.

Maven

Add dependencies (you can also add other modules that you need):

<dependency>
    <groupId>org.jetbrains.kotlinx</groupId>
    <artifactId>kotlinx-coroutines-core</artifactId>
    <version>1.3.3</version>
</dependency>

And make sure that you use the latest Kotlin version:

<properties>
    <kotlin.version>1.3.61</kotlin.version>
</properties>

Gradle

Add dependencies (you can also add other modules that you need):

dependencies {
    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.3'
}

And make sure that you use the latest Kotlin version:

buildscript {
    ext.kotlin_version = '1.3.61'
}

Make sure that you have either jcenter() or mavenCentral() in the list of repositories:

repository {
    jcenter()
}

Gradle Kotlin DSL

Add dependencies (you can also add other modules that you need):

dependencies {
    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.3")
}

And make sure that you use the latest Kotlin version:

plugins {
    kotlin("jvm") version "1.3.61"
}

Make sure that you have either jcenter() or mavenCentral() in the list of repositories.

Multiplatform

Core modules of kotlinx.coroutines are also available for Kotlin/JS and Kotlin/Native. In common code that should get compiled for different platforms, add dependency to
kotlinx-coroutines-core-common
(follow the link to get the dependency declaration snippet).

Android

Add kotlinx-coroutines-android module as dependency when using kotlinx.coroutines on Android:

implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.3'

This gives you access to Android Dispatchers.Main coroutine dispatcher and also makes sure that in case of crashed coroutine with unhandled exception this exception is logged before crashing Android application, similarly to the way uncaught exceptions in threads are handled by Android runtime.

R8 and ProGuard

R8 and ProGuard rules are bundled into the kotlinx-coroutines-android module. For more details see "Optimization" section for Android.

JS

Kotlin/JS version of kotlinx.coroutines is published as kotlinx-coroutines-core-js (follow the link to get the dependency declaration snippet).

You can also use kotlinx-coroutines-core package via NPM.

Native

Kotlin/Native version of kotlinx.coroutines is published as kotlinx-coroutines-core-native (follow the link to get the dependency declaration snippet).

Only single-threaded code (JS-style) on Kotlin/Native is currently supported. Kotlin/Native supports only Gradle version 4.10 and you need to enable Gradle metadata in your settings.gradle file:

enableFeaturePreview('GRADLE_METADATA')

Since Kotlin/Native does not generally provide binary compatibility between versions, you should use the same version of Kotlin/Native compiler as was used to build kotlinx.coroutines.

Building

This library is built with Gradle. To build it, use ./gradlew build. You can import this project into IDEA, but you have to delegate build actions to Gradle (in Preferences -> Build, Execution, Deployment -> Build Tools -> Gradle -> Runner)

Requirements

  • JDK >= 11 referred to by the JAVA_HOME environment variable.
  • JDK 1.6 referred to by the JDK_16 environment variable. It is okay to have JDK_16 pointing to JAVA_HOME for external contributions.
  • JDK 1.8 referred to by the JDK_18 environment variable. Only used by nightly stress-tests. It is okay to have JDK_16 pointing to JAVA_HOME for external contributions.

Contributions and releases

All development (both new features and bug fixes) is performed in develop branch. This way master sources always contain sources of the most recently released version. Please send PRs with bug fixes to develop branch. Fixes to documentation in markdown files are an exception to this rule. They are updated directly in master.

The develop branch is pushed to master during release.

  • Full release procedure checklist is here.
  • Steps for contributing new integration modules are explained here.
  • Use Knit for updates to documentation:
    • In project root directory run ./gradlew knit.
    • Commit updated documents and examples together with other changes.
  • Use Binary Compatibility Validator for updates to public API:
    • In project root directory run ./gradlew apiDump.
    • Commit updated API index together with other changes.