commit	ac5f54fa86b9339978027a71ad52edfcf3cdcfea	[log] [tgz]
author	Peter Kalauskas <[email protected]>	Thu Oct 17 11:02:28 2024 -0700
committer	Peter Kalauskas <[email protected]>	Thu Oct 17 11:02:29 2024 -0700
tree	d8f47c423f66c6e07826f8c696636df479c5b290
parent	8810b50d3c392544956a89c4787090253cf55808 [diff]
parent	cd696d3f8f4afdbc735915c2bded974616331b55 [diff]

tree: d8f47c423f66c6e07826f8c696636df479c5b290

README.md

kotlinx.coroutines

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

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

Play with coroutines online here

Modules

core — common coroutines across all platforms:
- launch and async coroutine builders returning Job and Deferred light-weight futures with cancellation support;
- Dispatchers object with Main dispatcher for Android/Swing/JavaFx (which require the corresponding artifacts in runtime) and Darwin (included out of the box), and Default dispatcher for background coroutines;
- delay and yield top-level suspending functions;
- Flow — cold asynchronous stream with flow builder and comprehensive operator set (filter, map, etc);
- Channel, Mutex, and Semaphore communication and synchronization primitives;
- coroutineScope, supervisorScope, withContext, and withTimeout scope builders;
- MainScope() for Android and UI applications;
- SupervisorJob() and CoroutineExceptionHandler for supervision of coroutines hierarchies;
- select expression support and more.
core/jvm — additional core features available on Kotlin/JVM:
- Dispatchers.IO dispatcher for blocking coroutines;
- Executor.asCoroutineDispatcher extension, custom thread pools, and more;
- Integrations with CompletableFuture and JVM-specific extensions.
core/js — additional core features available on Kotlin/JS:
- Integration with Promise via Promise.await and promise builder;
- Integration with Window via Window.asCoroutineDispatcher, etc.
test — test utilities for coroutines:
- Dispatchers.setMain to override Dispatchers.Main in tests;
- TestCoroutineScope to test suspending functions and coroutines.
debug — debug utilities for coroutines:
- DebugProbes API to probe, keep track of, print and dump active coroutines;
- CoroutinesTimeout test rule to automatically dump coroutines on test timeout.
- Automatic integration with BlockHound.
reactive — modules that provide builders and iteration support for various reactive streams libraries:
- Reactive Streams (Publisher.collect, Publisher.awaitSingle, kotlinx.coroutines.reactive.publish, etc),
- Flow (JDK 9) (the same interface as for Reactive Streams),
- RxJava 2.x (rxFlowable, rxSingle, etc), and
- RxJava 3.x (rxFlowable, rxSingle, etc), and
- Project Reactor (flux, mono, etc).
ui — modules that provide the Main dispatcher for various single-threaded UI libraries:
- Android, JavaFX, and Swing.
integration — modules that provide integration with various asynchronous callback- and future-based libraries:
- Guava ListenableFuture.await, and Google Play Services Task.await;
- SLF4J MDC integration via MDCContext.

Documentation

Presentations and videos:
- Kotlin Coroutines in Practice (Roman Elizarov at KotlinConf 2018, slides)
- Deep Dive into Coroutines (Roman Elizarov at KotlinConf 2017, slides)
- History of Structured Concurrency in Coroutines (Roman Elizarov at Hydra 2019, slides)
Guides and manuals:
- Guide to kotlinx.coroutines by example (read it first)
- Guide to UI programming with coroutines
- Debugging capabilities in kotlinx.coroutines
Compatibility policy and experimental annotations
Change log for kotlinx.coroutines
Coroutines design document (KEEP)
Full kotlinx.coroutines API reference

Using in your projects

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

And make sure that you use the latest Kotlin version:

<properties>
    <kotlin.version>1.9.21</kotlin.version>
</properties>

Gradle

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

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

And make sure that you use the latest Kotlin version:

plugins {
    // For build.gradle.kts (Kotlin DSL)
    kotlin("jvm") version "1.9.21"
    
    // For build.gradle (Groovy DSL)
    id "org.jetbrains.kotlin.jvm" version "1.9.21"
}

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

repositories {
    mavenCentral()
}

Android

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

implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:1.8.1")

This gives you access to the Android Dispatchers.Main coroutine dispatcher and also makes sure that in case of a crashed coroutine with an unhandled exception that this exception is logged before crashing the Android application, similarly to the way uncaught exceptions in threads are handled by the 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.

Avoiding including the debug infrastructure in the resulting APK

The kotlinx-coroutines-core artifact contains a resource file that is not required for the coroutines to operate normally and is only used by the debugger. To exclude it at no loss of functionality, add the following snippet to the android block in your Gradle file for the application subproject:

packagingOptions {
    resources.excludes += "DebugProbesKt.bin"
}

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, you can add a dependency to kotlinx-coroutines-core right to the commonMain source set:

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

Platform-specific dependencies are recommended to be used only for non-multiplatform projects that are compiled only for target platform.

JS

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

Native

Kotlin/Native version of kotlinx.coroutines is published as kotlinx-coroutines-core-$platform where $platform is the target Kotlin/Native platform. Targets are provided in accordance with official K/N target support.

Building and Contributing

See Contributing Guidelines.