Releases: Kotlin/kotlinx.coroutines
Releases · Kotlin/kotlinx.coroutines
0.21.2
- Fixed
openSubscription
extension for reactivePublisher
/Observable
/Flowable
when used withselect { ... }
and added an optionalrequest
parameter to specify how many elements are requested from publisher in advance on subscription (see #197). - Simplified implementation of
Channel.flatMap
usingtoChannel
function to work around Android 5.0 APK install SIGSEGV (see #205).
0.21.1
- Improved performance of coroutine dispatching (
DispatchTask
instance is no longer allocated). - Fixed
Job.cancel
andCompletableDeferred.complete
to support cancelling/completing states and properly wait for their children to complete on join/await (see #199). - Fixed a bug in binary heap implementation (used internally by
delay
) which could have resulted in wrong delay time in rare circumstances. - Coroutines library for Kotlin/JS:
Promise.asDeferred
immediately installs handlers to avoid "Unhandled promise rejection" warning.- Use
window.postMessage
instead ofsetTimeout
for coroutines inside the browser to avoid timeout throttling (see #194). - Use custom queue in
Window.awaitAnimationFrame
to align all animations and reduce overhead. - Introduced
Window.asCoroutineDispatcher()
extension function.
JS
- Migrated to Kotlin 1.2.10.
- Coroutines library for Kotlin/JS and multiplatform projects (see #33):
launch
andasync
coroutine builders.Job
andDeferred
light-weight future with cancellation support.delay
andyield
top-level suspending functions.await
extension for JSPromise
andasPromise
/asDeferred
conversions.promise
coroutine builder.Job()
andCompletableDeferred()
factories.- Full support for parent-child coroutine hierarchies.
Window.awaitAnimationFrame
extension function.- Sample frontend Kotlin/JS application with coroutine-driven animations.
run
is deprecated and renamed towithContext
(see #134).runBlocking
andEventLoop
implementations optimized (see #190).
0.20
- Migrated to Kotlin 1.2.0.
- Channels:
- Sequence-like
filter
,map
, etc extensions onReceiveChannel
are introduced (see #88 by @fvasco and #69 by @konrad-kaminski). - Introduced
ReceiveChannel.cancel
method. - All operators on
ReceiveChannel
fully consume the original channel (cancel
it when they are done) using a helperconsume
extension. - Deprecated
ActorJob
andProducerJob
;actor
now returnsSendChannel
andproduce
returnsReceiveChannel
(see #127). SendChannel.sendBlocking
extension method (see #157 by @fvasco).
- Sequence-like
- Parent-child relations between coroutines:
- Introduced an optional
parent
job parameter for all coroutine builders so that code with an explict parentJob
is more natural. - Added
parent
parameter toCompletableDeferred
constructor. - Introduced
Job.children
property. Job.cancelChildren
is now an extension (member is deprecated and hidden).Job.joinChildren
extension is introduced.- Deprecated
Job.attachChild
as a error-prone API. - Fixed StackOverflow when waiting for a lot of completed children that did not remove their handlers from the parent.
- Introduced an optional
- Use
java.util.ServiceLoader
to find default instances ofCoroutineExceptionHandler
. - Android UI integration:
- Added missing
DefaultDispatcher
on some reactive operators (see #174 by @fvasco) - Fixed
actor
andproduce
so that a cancellation of a Job cancels the underlying channel (closes and removes all the pending messages). - Fixed sporadic failure of
example-context-06
(see #160) - Fixed hang of
Job.start
on lazy coroutine with attachedinvokeOnCompletion
handler. - A more gradual introduction to
runBlocking
and coroutines in the guide (see #166).
0.19.3
0.19.2
- Fixed
ArrayBroadcastChannel
receive of stale elements onopenSubscription
. Only elements that are sent after invocation ofopenSubscription
are received now. - Added a default value for
context
parameter torxFlowable
(see PR #146 by @PhilGlass). - Exception propagation logic from cancelled coroutines is adjusted (see #152):
- When cancelled coroutine crashes due to some other exception, this other exception becomes the cancellation reason of the coroutine, while the original cancellation reason is suppressed.
UnexpectedCoroutineException
is no longer used to report those cases as is removed.- This fixes a race between crash of CPU-consuming coroutine and cancellation which resulted in an unhandled exception and lead to crashes on Android.
run
uses cancelling state & propagates exceptions when cancelled (see #147):- When coroutine that was switched into a different dispatcher using
run
is cancelled, the run invocation does not complete immediately, but waits until the body completes. - If the body completes with exception, then this exception is propagated.
- When coroutine that was switched into a different dispatcher using
- No
Job
innewSingleThreadContext
andnewFixedThreadPoolContext
anymore (see #149, #151):- This resolves the common issue of using
run(ctx)
where ctx comes from eithernewSingleThreadContext
ornewFixedThreadPoolContext
invocation. They both used to return a combination of dispatcher + job, and this job was overriding the parent job, thus preventing propagation of cancellation. Not anymore. ThreadPoolDispatcher
class is now public and is the result type for both functions. It has theclose
method to release the thread pool.
- This resolves the common issue of using
0.19.1
- Failed parent Job cancels all children jobs, then waits for them them. This makes parent-child hierarchies easier to get working right without having to use
try/catch
or other exception handlers. - Fixed a race in
ArrayBroadcastChannel
betweensend
andopenChannel
invocations (see #138). - Fixed quite a rare race in
runBlocking
that resulted inAssertionError
. Unfortunately, cannot write a reliable stress-test to reproduce it. - Updated Reactor support to leverage Bismuth release train (contributed by @sdeleuze, see PR #141)
0.19
- This release is published to Maven Central.
DefaultDispatcher
is introduced (see #136):launch
,async
,produce
,actor
and other integration-specific coroutine builders now use
DefaultDispatcher
as the default value for theircontext
parameter.- When a context is explicitly specified,
newCoroutineContext
function checks if there is any
interceptor/dispatcher defined in the context and usesDefaultDispatcher
if there is none. DefaultDispatcher
is currently defined to be equal toCommonPool
.- Examples in the guide now start with
launch { ... }
code and explanation on the nature
and the need for coroutine context starts in "Coroutine context and dispatchers" section.
- Parent coroutines now wait for their children (see #125):
- Job completing state is introduced in documentation as a state in which parent coroutine waits for its children.
Job.attachChild
andJob.cancelChildren
are introduced.Job.join
now always checks cancellation status of invoker coroutine for predictable behavior when joining
failed child coroutine.Job.cancelAndJoin
extension is introduced.CoroutineContext.cancel
andCoroutineContext.cancelChildren
extensions are introduced for convenience.withTimeout
/withTimeoutOrNull
blocks become proper coroutines that haveCoroutineScope
and wait for children, too.- Diagnostics in cancellation and unexpected exception messages are improved,
coroutine name is included in debug mode. - Fixed cancellable suspending functions to throw
CancellationException
(as was documented before) even when
the coroutine is cancelled with another application-specific exception. JobCancellationException
is introduced as a specific subclass ofCancellationException
which is
used for coroutines that are cancelled without cause and to wrap application-specific exceptions.Job.getCompletionException
is renamed toJob.getCancellationException
and return a wrapper exception if needed.- Introduced
Deferred.getCompletionExceptionOrNull
to get not-wrapped exception result ofasync
task. - Updated docs for
Job
&Deferred
to explain parent/child relations.
select
expression is modularized:SelectClause(0,1,2)
interfaces are introduced, so that synchronization
constructs can define their select clauses without having to modify
the source of theSelectBuilder
inkotlinx-corounes-core
module.Job.onJoin
,Deferred.onAwait
,Mutex.onLock
,SendChannel.onSend
,ReceiveChannel.onReceive
, etc
that were functions before are now properties returning the corresponding select clauses. Old functions
are left in bytecode for backwards compatibility on use-site, but any outside code that was implementing those
interfaces by itself must be updated.- This opens road to moving channels into a separate module in future updates.
- Renamed
TimeoutException
toTimeoutCancellationException
(old name is deprecated). - Fixed various minor problems:
kotlinx-coroutines-io
module is introduced. It is a work-in-progress onByteReadChannel
andByteWriteChannel
interfaces, their implementations, and related classes to enable convenient coroutine integration with various
asynchronous I/O libraries and sockets. It is currently unstable and will change in the next release.
0.18
- Kotlin 1.1.4 is required to use this version, which enables:
withLock
andconsumeEach
functions are now inline suspend functions.JobSupport
class implementation is optimized (one fewer field).
TimeoutException
is public (see #89).- Improvements to
Mutex
(courtesy of @fvasco): - Fixed NPE when
ArrayBroadcastChannel
is closed concurrently with receive (see #97). - Fixed bug in internal class LockFreeLinkedList that resulted in ISE under stress in extremely rare circumstances.
- Integrations:
- quasar: Introduced integration with suspendable JVM functions
that are instrumented with Parallel Universe Quasar
(thanks to the help of @pron). - reactor: Replaced deprecated
setCancellation
withonDipose
and
updated to Aluminium-SR3 release (courtesy of @yxf07, see #96) - jdk8: Added adapters for
java.time
classes (courtesy of @fvasco, see #93)
- quasar: Introduced integration with suspendable JVM functions
0.17
CompletableDeferred
is introduced as a set-once event-like communication primitive (see #70).- Coroutines guide uses it in a section on actors.
CompletableDeferred
is an interface with private impl (courtesy of @fvasco, see #86).- It extends
Deferred
interface withcomplete
andcompleteExceptionally
functions.
Job.join
andDeferred.await
wait until a cancelled coroutine stops execution (see #64).Job
andDeferred
have a new cancelling state which they enter on invocation ofcancel
.Job.invokeOnCompletion
has an additional overload withonCancelling: Boolean
parameter to install handlers that are fired as soon as coroutine enters cancelling state as opposed to waiting until it completes.- Internal
select
implementation is refactored to decouple it fromJobSupport
internal class and to optimize its state-machine. - Internal
AbstractCoroutine
class is refactored so that it is extended only by true coroutines, all of which support the new cancelling state.
CoroutineScope.context
is renamed tocoroutineContext
to avoid conflicts with other usages ofcontext
in applications (like Android context, see #75).BroadcastChannel.open
is renamed toopenSubscription
(see #54).- Fixed
StackOverflowError
in a convoy ofMutex.unlock
invokers withUnconfined
dispatcher (see #80). - Fixed
SecurityException
when trying to use coroutines library with installedSecurityManager
. - Fixed a bug in
withTimeoutOrNull
in case with nested timeouts when coroutine was cancelled before it was ever suspended. - Fixed a minor problem with
awaitFirst
on reactive streams that would have resulted in spurious stack-traces printed on the console when used with publishers/observables that continue to invokeonNext
despite being cancelled/disposed (which they are technically allowed to do by specification). - All factory functions for various interfaces are implemented as top-level functions (affects
Job
,Channel
,BroadcastChannel
,Mutex
,EventLoop
, andCoroutineExceptionHandler
). Previous approach of usingoperator invoke
on their companion objects is deprecated. - Nicer-to-use debug
toString
implementations for coroutine dispatcher tasks and continuations. - A default dispatcher for
delay
is rewritten and now shares code withEventLoopImpl
that is used byrunBlocking
. It internally supports non-defaultTimeSource
so that delay-using tests can be written with "virtual time" by replacing their time source for the duration of tests (this feature is not available outside of the library).