Github url

kotlinx.coroutines

by Kotlin

Library support for Kotlin coroutines

7.8K Stars 1.1K Forks Last release: about 2 months ago (1.3.7) Apache License 2.0 2.1K Commits 69 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

kotlinx.coroutines

official JetBrains projectGitHub licenseDownload

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

1.3.71

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

And make sure that you use the latest Kotlin version:

<properties>
    <kotlin.version>1.3.71</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.7' }

And make sure that you use the latest Kotlin version:

buildscript { ext.kotlin\_version = '1.3.71' }

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.7") }

And make sure that you use the latest Kotlin version:

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

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

](https://search.maven.org/artifact/org.jetbrains.kotlinx/kotlinx-coroutines-core-common/1.3.7/jar)(follow the link to get the dependency declaration snippet).

Android

Add [

kotlinx-coroutines-android

](https://github.com/Kotlin/kotlinx.coroutines/blob/master/ui/kotlinx-coroutines-android)module as dependency when using

kotlinx.coroutines

on Android:

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

This gives you access to Android Dispatchers.Maincoroutine 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

](https://github.com/Kotlin/kotlinx.coroutines/blob/master/ui/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

](https://search.maven.org/artifact/org.jetbrains.kotlinx/kotlinx-coroutines-core-js/1.3.7/jar)(follow the link to get the dependency declaration snippet).

You can also use [

kotlinx-coroutines-core

](https://www.npmjs.com/package/kotlinx-coroutines-core) package via NPM.

Native

Kotlin/Native version of

kotlinx.coroutines

is published as [

kotlinx-coroutines-core-native

](https://search.maven.org/artifact/org.jetbrains.kotlinx/kotlinx-coroutines-core-native/1.3.7/jar)(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\_18
    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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.