Remove the `@PublishedApi` that are no longer needed (#4089)

According to @mvicsokolova, the following entry points are not
used by IDEA since 2020:

kotlinx.coroutines.debug.internal.StackTraceFrame
	field callerFrame
	field stackTraceElement
kotlinx.coroutines.StandaloneCoroutine
	field _state
	field context
kotlinx.coroutines.ChildContinuation
	field child
kotlinx.coroutines.CancellableContinuationImpl
	field _decision
	field delegate
	field resumeMode
	field submissionTime
	field context
kotlinx.coroutines.DispatchedContinuation
	field continuation

This leaves only the following *internal* entry points:

kotlinx.coroutines.debug.internal.DebugCoroutineInfo
	method getCreationStackTrace()
	method getState()
	method lastObservedStackTrace()
	field context
	field sequenceNumber
	field lastObservedFrame
	field lastObservedThread
kotlinx.coroutines.debug.internal.DebugCoroutineInfoImpl
	method getCreationStackTrace()
	method getContext()
	field lastObservedThread
	field _state
	field _lastObservedFrame
	field sequenceNumber
kotlinx.coroutines.debug.internal.DebugProbesImpl
	field INSTANCE
	method isInstalled$kotlinx_coroutines_debug()
	method isInstalled$kotlinx_coroutines_core()
	method enhanceStackTraceWithThreadDump()
	method dumpCoroutinesInfo()
	method dumpCoroutinesInfoAsJsonAndReferences()
	method enhanceStackTraceWithThreadDumpAsJson()
kotlinx.coroutines.debug.internal.DebugProbesImpl$CoroutineOwner
	field info
kotlinx.coroutines.CoroutineId
	field Key
	method getId()

... the following *public* entry points:

kotlinx.coroutines.CoroutineName
	field Key
	method getName()
kotlinx.coroutines.Job
	field Key
kotlinx.coroutines.CoroutineDispatcher
	field Key

... and these entry points outside of the library:

kotlin.coroutines.CombinedContext
	method get()
kotlin.coroutines.jvm.internal.DebugMetadataKt
	method getStackTraceElement()
	method getSpilledVariableFieldMapping()

This commit updates the comments and removes the extraneous
`@PublishedApi` annotations, giving us more flexibility to change
code.
10 files changed
tree: fd42598603c130d1e2920a094053d0d90ea894f0
  1. .github/
  2. .idea/
  3. benchmarks/
  4. buildSrc/
  5. docs/
  6. dokka-templates/
  7. gradle/
  8. integration/
  9. integration-testing/
  10. kotlinx-coroutines-bom/
  11. kotlinx-coroutines-core/
  12. kotlinx-coroutines-debug/
  13. kotlinx-coroutines-test/
  14. license/
  15. reactive/
  16. site/
  17. test-utils/
  18. ui/
  19. .gitignore
  20. build.gradle.kts
  21. bump-version.sh
  22. CHANGES.md
  23. CHANGES_UP_TO_1.7.md
  24. CODE_OF_CONDUCT.md
  25. CONTRIBUTING.md
  26. coroutines-guide.md
  27. gradle.properties
  28. gradlew
  29. gradlew.bat
  30. knit.properties
  31. LICENSE.txt
  32. README.md
  33. RELEASE.md
  34. settings.gradle.kts
README.md

kotlinx.coroutines

Kotlin Stable JetBrains official project GitHub license Download Kotlin Slack channel

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

Documentation

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-Beta</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-Beta")
}

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-Beta")

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

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.