| commit | bc8160b72a8c083048f59eed6b5c81fb685dd595 | [log] [tgz] |
|---|---|---|
| author | globsterg <[email protected]> | Tue Jul 30 11:52:23 2024 +0300 |
| committer | GitHub <[email protected]> | Tue Jul 30 10:52:23 2024 +0200 |
| tree | c014729f4ab9fb49badac628c58d6d13d6eb42bf | |
| parent | ab279a765450cbfc214f9dad9cf9a1f8fd2d274d [diff] |
Extend the KDoc for some channel APIs (#4148) * Reword the BufferOverflow KDoc for consistency in the entry list Before, the description of `SUSPEND` was phrased in terms of what will happen, while the rest of the entries were described in an imperative form, that is, as commands as to what should happen. Now, all entries are clarified using a descriptive form. * Describe the situations in which BufferOverflow options are useful * Expand the documentation for channel consumption functions Added explanations of what exactly happens on each code path, how these operators ensure that all elements get processed eventually, and provided some usage examples. * Specify the behavior of Channel.consumeEach on scope cancellation * Extend the documentation for `ProducerScope.awaitClose` Filed #4149 * Reword a misleading statement in the `produce` documentation Currently, the documentation states that uncaught exceptions will lead to the channel being closed. "Uncaught exceptions" is a special thing in kotlinx.coroutines: <https://kotlinlang.org/docs/exception-handling.html#coroutineexceptionhandler> These are not just exceptions that are not wrapped in a try-catch, these are exceptions that can not be propagated to a root coroutine via structured concurrency. Fixed the wording and added a test that shows that uncaught coroutine exceptions are not handled in any special manner. * Document `awaitClose` and `invokeOnClose` interactions Turns out, only a single invocation of either `awaitClose` or `invokeOnClose` is allowed in the lifetime of a channel. Document that. * Document how consuming operators handle failed channels * Document cancelling the coroutine but not the channel of `produce` * Don't use the magic constant 0 in default parameters of `produce` Instead, use `Channel.RENDEZVOUS` so that a meaningful constant is shown in Dokka's output. * Fix an incorrect statement in `produce` docs Currently, the docs claim that attempting to receive from a failed channel fails. However, the documentation for `Channel` itself correctly states that before `receive` fails, the elements that were already sent will be processed first. Corrected this and added a test demonstrating the behavior. * Add samples to the `produce` documentation and restructure it
Library support for Kotlin coroutines with multiplatform support. This is a companion version for the Kotlin 2.0.0 release.
suspend fun main() = coroutineScope { launch { delay(1000) println("Kotlin Coroutines World!") } println("Hello") }
Play with coroutines online here
CompletableFuture and JVM-specific extensions.Promise via Promise.await and promise builder;Window via Window.asCoroutineDispatcher, etc.Add dependencies (you can also add other modules that you need):
<dependency> <groupId>org.jetbrains.kotlinx</groupId> <artifactId>kotlinx-coroutines-core</artifactId> <version>1.9.0-RC</version> </dependency>
And make sure that you use the latest Kotlin version:
<properties> <kotlin.version>2.0.0</kotlin.version> </properties>
Add dependencies (you can also add other modules that you need):
dependencies { implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.9.0-RC") }
And make sure that you use the latest Kotlin version:
plugins { // For build.gradle.kts (Kotlin DSL) kotlin("jvm") version "2.0.0" // For build.gradle (Groovy DSL) id "org.jetbrains.kotlin.jvm" version "2.0.0" }
Make sure that you have mavenCentral() in the list of repositories:
repositories { mavenCentral() }
Add kotlinx-coroutines-android module as a dependency when using kotlinx.coroutines on Android:
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:1.9.0-RC")
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 rules are bundled into the kotlinx-coroutines-android module. For more details see “Optimization” section for Android.
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" }
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.9.0-RC") } }
Platform-specific dependencies are recommended to be used only for non-multiplatform projects that are compiled only for target platform.
Kotlin/JS version of kotlinx.coroutines is published as kotlinx-coroutines-core-js (follow the link to get the dependency declaration snippet).
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.