aboutsummaryrefslogtreecommitdiffstats
path: root/kotlinx-coroutines-core/common/src/channels/Channel.kt
diff options
context:
space:
mode:
Diffstat (limited to 'kotlinx-coroutines-core/common/src/channels/Channel.kt')
-rw-r--r--kotlinx-coroutines-core/common/src/channels/Channel.kt587
1 files changed, 587 insertions, 0 deletions
diff --git a/kotlinx-coroutines-core/common/src/channels/Channel.kt b/kotlinx-coroutines-core/common/src/channels/Channel.kt
new file mode 100644
index 00000000..f13a15c2
--- /dev/null
+++ b/kotlinx-coroutines-core/common/src/channels/Channel.kt
@@ -0,0 +1,587 @@
+/*
+ * Copyright 2016-2018 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+@file:Suppress("FunctionName")
+
+package kotlinx.coroutines.channels
+
+import kotlinx.coroutines.*
+import kotlinx.coroutines.channels.Channel.Factory.CONFLATED
+import kotlinx.coroutines.channels.Channel.Factory.RENDEZVOUS
+import kotlinx.coroutines.channels.Channel.Factory.UNLIMITED
+import kotlinx.coroutines.channels.Channel.Factory.BUFFERED
+import kotlinx.coroutines.channels.Channel.Factory.CHANNEL_DEFAULT_CAPACITY
+import kotlinx.coroutines.internal.systemProp
+import kotlinx.coroutines.selects.*
+import kotlin.jvm.*
+import kotlin.internal.*
+
+/**
+ * Sender's interface to [Channel].
+ */
+public interface SendChannel<in E> {
+ /**
+ * Returns `true` if this channel was closed by invocation of [close] and thus
+ * the [send] and [offer] attempts throws exception.
+ *
+ * **Note: This is an experimental api.** This property may change its semantics and/or name in the future.
+ */
+ @ExperimentalCoroutinesApi
+ public val isClosedForSend: Boolean
+
+ /**
+ * Returns `true` if the channel is full (out of capacity) and the [send] attempt will suspend.
+ * This function returns `false` for [isClosedForSend] channel.
+ *
+ * @suppress **Will be removed in next releases, no replacement.**
+ */
+ @ExperimentalCoroutinesApi
+ @Deprecated(level = DeprecationLevel.ERROR, message = "Will be removed in next releases without replacement")
+ public val isFull: Boolean
+
+ /**
+ * Adds [element] into to this channel, suspending the caller while the buffer of this channel is full
+ * or if it does not exist, or throws exception if the channel [isClosedForSend] (see [close] for details).
+ *
+ * Note that closing a channel _after_ this function had suspended does not cause this suspended send invocation
+ * to abort, because closing a channel is conceptually like sending a special "close token" over this channel.
+ * All elements that are sent over the channel are delivered in first-in first-out order. The element that
+ * is being sent will get delivered to receivers before a close token.
+ *
+ * This suspending function is cancellable. If the [Job] of the current coroutine is cancelled or completed while this
+ * function is suspended, this function immediately resumes with [CancellationException].
+ *
+ * *Cancellation of suspended send is atomic* -- when this function
+ * throws [CancellationException] it means that the [element] was not sent to this channel.
+ * As a side-effect of atomic cancellation, a thread-bound coroutine (to some UI thread, for example) may
+ * continue to execute even after it was cancelled from the same thread in the case when this send operation
+ * was already resumed and the continuation was posted for execution to the thread's queue.
+ *
+ * Note that this function does not check for cancellation when it is not suspended.
+ * Use [yield] or [CoroutineScope.isActive] to periodically check for cancellation in tight loops if needed.
+ *
+ * This function can be used in [select] invocation with [onSend] clause.
+ * Use [offer] to try sending to this channel without waiting.
+ */
+ public suspend fun send(element: E)
+
+ /**
+ * Clause for [select] expression of [send] suspending function that selects when the element that is specified
+ * as parameter is sent to the channel. When the clause is selected the reference to this channel
+ * is passed into the corresponding block.
+ *
+ * The [select] invocation fails with exception if the channel [isClosedForSend] (see [close] for details).
+ */
+ public val onSend: SelectClause2<E, SendChannel<E>>
+
+ /**
+ * Adds [element] into this queue if it is possible to do so immediately without violating capacity restrictions
+ * and returns `true`. Otherwise, it returns `false` immediately
+ * or throws exception if the channel [isClosedForSend] (see [close] for details).
+ */
+ public fun offer(element: E): Boolean
+
+ /**
+ * Closes this channel.
+ * This is an idempotent operation -- subsequent invocations of this function have no effect and return `false`.
+ * Conceptually, its sends a special "close token" over this channel.
+ *
+ * Immediately after invocation of this function
+ * [isClosedForSend] starts returning `true`. However, [isClosedForReceive][ReceiveChannel.isClosedForReceive]
+ * on the side of [ReceiveChannel] starts returning `true` only after all previously sent elements
+ * are received.
+ *
+ * A channel that was closed without a [cause] throws [ClosedSendChannelException] on attempts to send
+ * and [ClosedReceiveChannelException] on attempts to receive.
+ * A channel that was closed with non-null [cause] is called a _failed_ channel. Attempts to send or
+ * receive on a failed channel throw the specified [cause] exception.
+ */
+ public fun close(cause: Throwable? = null): Boolean
+
+ /**
+ * Registers handler which is synchronously invoked once the channel is [closed][close]
+ * or receiving side of this channel is [cancelled][ReceiveChannel.cancel].
+ * Only one handler can be attached to the channel during channel's lifetime.
+ * Handler is invoked when [isClosedForSend] starts to return `true`.
+ * If channel is already closed, handler is invoked immediately.
+ *
+ * The meaning of `cause` that is passed to the handler:
+ * * `null` if channel was closed or cancelled without corresponding argument
+ * * close or cancel cause otherwise.
+ *
+ * Example of usage (exception handling is omitted):
+ * ```
+ * val events = Channel(UNLIMITED)
+ * callbackBasedApi.registerCallback { event ->
+ * events.offer(event)
+ * }
+ *
+ * val uiUpdater = launch(Dispatchers.Main, parent = UILifecycle) {
+ * events.consume {}
+ * events.cancel()
+ * }
+ *
+ * events.invokeOnClose { callbackBasedApi.stop() }
+ *
+ * ```
+ *
+ * **Note: This is an experimental api.** This function may change its semantics, parameters or return type in the future.
+ *
+ * @throws UnsupportedOperationException if underlying channel doesn't support [invokeOnClose].
+ * Implementation note: currently, [invokeOnClose] is unsupported only by Rx-like integrations
+ *
+ * @throws IllegalStateException if another handler was already registered
+ */
+ @ExperimentalCoroutinesApi
+ public fun invokeOnClose(handler: (cause: Throwable?) -> Unit)
+}
+
+/**
+ * Receiver's interface to [Channel].
+ */
+public interface ReceiveChannel<out E> {
+ /**
+ * Returns `true` if this channel was closed by invocation of [close][SendChannel.close] on the [SendChannel]
+ * side and all previously sent items were already received, so that the [receive] attempt
+ * throws [ClosedReceiveChannelException]. If the channel was closed because of the exception, it
+ * is considered closed, too, but it is called a _failed_ channel. All suspending attempts to receive
+ * an element from a failed channel throw the original [close][SendChannel.close] cause exception.
+ *
+ * **Note: This is an experimental api.** This property may change its semantics and/or name in the future.
+ */
+ @ExperimentalCoroutinesApi
+ public val isClosedForReceive: Boolean
+
+ /**
+ * Returns `true` if the channel is empty (contains no elements) and the [receive] attempt will suspend.
+ * This function returns `false` for [isClosedForReceive] channel.
+ */
+ @ExperimentalCoroutinesApi
+ public val isEmpty: Boolean
+
+ /**
+ * Retrieves and removes the element from this channel suspending the caller while this channel is empty,
+ * or throws [ClosedReceiveChannelException] if the channel [isClosedForReceive].
+ * If the channel was closed because of the exception, it is called a _failed_ channel and this function
+ * throws the original [close][SendChannel.close] cause exception.
+ *
+ * This suspending function is cancellable. If the [Job] of the current coroutine is cancelled or completed while this
+ * function is suspended, this function immediately resumes with [CancellationException].
+ *
+ * *Cancellation of suspended receive is atomic* -- when this function
+ * throws [CancellationException] it means that the element was not retrieved from this channel.
+ * As a side-effect of atomic cancellation, a thread-bound coroutine (to some UI thread, for example) may
+ * continue to execute even after it was cancelled from the same thread in the case when this receive operation
+ * was already resumed and the continuation was posted for execution to the thread's queue.
+ *
+ * Note that this function does not check for cancellation when it is not suspended.
+ * Use [yield] or [CoroutineScope.isActive] to periodically check for cancellation in tight loops if needed.
+ *
+ * This function can be used in [select] invocation with [onReceive] clause.
+ * Use [poll] to try receiving from this channel without waiting.
+ */
+ public suspend fun receive(): E
+
+ /**
+ * Clause for [select] expression of [receive] suspending function that selects with the element that
+ * is received from the channel.
+ * The [select] invocation fails with exception if the channel
+ * [isClosedForReceive] (see [close][SendChannel.close] for details).
+ */
+ public val onReceive: SelectClause1<E>
+
+ /**
+ * Retrieves and removes the element from this channel suspending the caller while this channel is empty,
+ * or returns `null` if the channel is [closed][isClosedForReceive] without cause
+ * or throws the original [close][SendChannel.close] cause exception if the channel has _failed_.
+ *
+ * This suspending function is cancellable. If the [Job] of the current coroutine is cancelled or completed while this
+ * function is suspended, this function immediately resumes with [CancellationException].
+ *
+ * *Cancellation of suspended receive is atomic* -- when this function
+ * throws [CancellationException] it means that the element was not retrieved from this channel.
+ * As a side-effect of atomic cancellation, a thread-bound coroutine (to some UI thread, for example) may
+ * continue to execute even after it was cancelled from the same thread in the case when this receive operation
+ * was already resumed and the continuation was posted for execution to the thread's queue.
+ *
+ * Note that this function does not check for cancellation when it is not suspended.
+ * Use [yield] or [CoroutineScope.isActive] to periodically check for cancellation in tight loops if needed.
+ *
+ * This function can be used in [select] invocation with [onReceiveOrNull] clause.
+ * Use [poll] to try receiving from this channel without waiting.
+ *
+ * @suppress **Deprecated**: in favor of receiveOrClosed and receiveOrNull extension.
+ */
+ @ObsoleteCoroutinesApi
+ @Suppress("INVISIBLE_REFERENCE", "INVISIBLE_MEMBER")
+ @LowPriorityInOverloadResolution
+ @Deprecated(
+ message = "Deprecated in favor of receiveOrClosed and receiveOrNull extension",
+ level = DeprecationLevel.WARNING,
+ replaceWith = ReplaceWith("receiveOrNull", "kotlinx.coroutines.channels.receiveOrNull")
+ )
+ public suspend fun receiveOrNull(): E?
+
+ /**
+ * Clause for [select] expression of [receiveOrNull] suspending function that selects with the element that
+ * is received from the channel or selects with `null` if the channel
+ * [isClosedForReceive] without cause. The [select] invocation fails with
+ * the original [close][SendChannel.close] cause exception if the channel has _failed_.
+ *
+ * @suppress **Deprecated**: in favor of onReceiveOrClosed and onReceiveOrNull extension.
+ */
+ @ObsoleteCoroutinesApi
+ @Suppress("INVISIBLE_REFERENCE", "INVISIBLE_MEMBER")
+ @LowPriorityInOverloadResolution
+ @Deprecated(
+ message = "Deprecated in favor of onReceiveOrClosed and onReceiveOrNull extension",
+ level = DeprecationLevel.WARNING,
+ replaceWith = ReplaceWith("onReceiveOrNull", "kotlinx.coroutines.channels.onReceiveOrNull")
+ )
+ public val onReceiveOrNull: SelectClause1<E?>
+
+ /**
+ * Retrieves and removes the element from this channel suspending the caller while this channel [isEmpty].
+ * This method returns [ValueOrClosed] with a value if element was successfully retrieved from the channel
+ * or [ValueOrClosed] with close cause if channel was closed.
+ *
+ * This suspending function is cancellable. If the [Job] of the current coroutine is cancelled or completed while this
+ * function is suspended, this function immediately resumes with [CancellationException].
+ *
+ * *Cancellation of suspended receive is atomic* -- when this function
+ * throws [CancellationException] it means that the element was not retrieved from this channel.
+ * As a side-effect of atomic cancellation, a thread-bound coroutine (to some UI thread, for example) may
+ * continue to execute even after it was cancelled from the same thread in the case when this receive operation
+ * was already resumed and the continuation was posted for execution to the thread's queue.
+ *
+ * Note, that this function does not check for cancellation when it is not suspended.
+ * Use [yield] or [CoroutineScope.isActive] to periodically check for cancellation in tight loops if needed.
+ *
+ * This function can be used in [select] invocation with [onReceiveOrClosed] clause.
+ * Use [poll] to try receiving from this channel without waiting.
+ *
+ * @suppress *This is an internal API, do not use*: Inline classes ABI is not stable yet and
+ * [KT-27524](https://youtrack.jetbrains.com/issue/KT-27524) needs to be fixed.
+ */
+ @InternalCoroutinesApi // until https://youtrack.jetbrains.com/issue/KT-27524 is fixed
+ public suspend fun receiveOrClosed(): ValueOrClosed<E>
+
+ /**
+ * Clause for [select] expression of [receiveOrClosed] suspending function that selects with the [ValueOrClosed] with a value
+ * that is received from the channel or selects with [ValueOrClosed] with a close cause if the channel
+ * [isClosedForReceive].
+ *
+ * @suppress *This is an internal API, do not use*: Inline classes ABI is not stable yet and
+ * [KT-27524](https://youtrack.jetbrains.com/issue/KT-27524) needs to be fixed.
+ */
+ @InternalCoroutinesApi // until https://youtrack.jetbrains.com/issue/KT-27524 is fixed
+ public val onReceiveOrClosed: SelectClause1<ValueOrClosed<E>>
+
+ /**
+ * Retrieves and removes the element from this channel, or returns `null` if this channel is empty
+ * or is [isClosedForReceive] without cause.
+ * It throws the original [close][SendChannel.close] cause exception if the channel has _failed_.
+ */
+ public fun poll(): E?
+
+ /**
+ * Returns new iterator to receive elements from this channels using `for` loop.
+ * Iteration completes normally when the channel is [isClosedForReceive] without cause and
+ * throws the original [close][SendChannel.close] cause exception if the channel has _failed_.
+ */
+ public operator fun iterator(): ChannelIterator<E>
+
+ /**
+ * Cancels reception of remaining elements from this channel with an optional [cause].
+ * This function closes the channel and removes all buffered sent elements from it.
+ *
+ * A cause can be used to specify an error message or to provide other details on
+ * a cancellation reason for debugging purposes.
+ * If the cause is not specified, then an instance of [CancellationException] with a
+ * default message is created to [close][SendChannel.close] the channel.
+ *
+ * Immediately after invocation of this function [isClosedForReceive] and
+ * [isClosedForSend][SendChannel.isClosedForSend]
+ * on the side of [SendChannel] start returning `true`. All attempts to send to this channel
+ * or receive from this channel will throw [CancellationException].
+ */
+ public fun cancel(cause: CancellationException? = null)
+
+ /**
+ * @suppress This method implements old version of JVM ABI. Use [cancel].
+ */
+ @Deprecated(level = DeprecationLevel.HIDDEN, message = "Since 1.2.0, binary compatibility with versions <= 1.1.x")
+ public fun cancel() = cancel(null)
+
+ /**
+ * @suppress This method has bad semantics when cause is not a [CancellationException]. Use [cancel].
+ */
+ @Deprecated(level = DeprecationLevel.HIDDEN, message = "Since 1.2.0, binary compatibility with versions <= 1.1.x")
+ public fun cancel(cause: Throwable? = null): Boolean
+}
+
+/**
+ * A discriminated union of [ReceiveChannel.receiveOrClosed] result,
+ * that encapsulates either successfully received element of type [T] from the channel or a close cause.
+ *
+ * :todo: Do not make it public before resolving todos in the code of this class.
+ *
+ * @suppress *This is an internal API, do not use*: Inline classes ABI is not stable yet and
+ * [KT-27524](https://youtrack.jetbrains.com/issue/KT-27524) needs to be fixed.
+ */
+@Suppress("NON_PUBLIC_PRIMARY_CONSTRUCTOR_OF_INLINE_CLASS")
+@InternalCoroutinesApi // until https://youtrack.jetbrains.com/issue/KT-27524 is fixed
+public inline class ValueOrClosed<out T>
+internal constructor(private val holder: Any?) {
+ /**
+ * Returns `true` if this instance represents received element.
+ * In this case [isClosed] returns `false`.
+ * todo: it is commented for now, because it is not used
+ */
+ //public val isValue: Boolean get() = holder !is Closed
+
+ /**
+ * Returns `true` if this instance represents close cause.
+ * In this case [isValue] returns `false`.
+ */
+ public val isClosed: Boolean get() = holder is Closed
+
+ /**
+ * Returns received value if this instance represents received value or throws [IllegalStateException] otherwise.
+ *
+ * :todo: Decide if it is needed how it shall be named with relation to [valueOrThrow]:
+ *
+ * So we have the following methods on ValueOrClosed: `value`, `valueOrNull`, `valueOrThrow`.
+ * On the other hand, the channel has the following receive variants:
+ * * `receive` which corresponds to `receiveOrClosed().valueOrThrow`... huh?
+ * * `receiveOrNull` which corresponds to `receiveOrClosed().valueOrNull`
+ * * `receiveOrClosed`
+ * For the sake of consider dropping this version of `value` and rename [valueOrThrow] to simply `value`.
+ */
+ @Suppress("UNCHECKED_CAST")
+ public val value: T
+ get() = if (holder is Closed) error(DEFAULT_CLOSE_MESSAGE) else holder as T
+
+ /**
+ * Returns received value if this element represents received value or `null` otherwise.
+ * :todo: Decide if it shall be made into extension that is available only for non-null T.
+ * Note: it might become inconsistent with kotlin.Result
+ */
+ @Suppress("UNCHECKED_CAST")
+ public val valueOrNull: T?
+ get() = if (holder is Closed) null else holder as T
+
+ /**
+ * :todo: Decide if it is needed how it shall be named with relation to [value].
+ * Note, that valueOrThrow rethrows the cause adding no meaningful information about the callsite,
+ * so if one is sure that ValueOrClosed is always value, this very property should be used.
+ * Otherwise, it could be very hard to locate the source of the exception.
+ * todo: it is commented for now, because it is not used
+ */
+ //@Suppress("UNCHECKED_CAST")
+ //public val valueOrThrow: T
+ // get() = if (holder is Closed) throw holder.exception else holder as T
+
+ /**
+ * Returns close cause of the channel if this instance represents close cause or throws
+ * [IllegalStateException] otherwise.
+ */
+ @Suppress("UNCHECKED_CAST")
+ public val closeCause: Throwable? get() =
+ if (holder is Closed) holder.cause else error("Channel was not closed")
+
+ /**
+ * @suppress
+ */
+ public override fun toString(): String =
+ when (holder) {
+ is Closed -> holder.toString()
+ else -> "Value($holder)"
+ }
+
+ internal class Closed(@JvmField val cause: Throwable?) {
+ // todo: it is commented for now, because it is not used
+ //val exception: Throwable get() = cause ?: ClosedReceiveChannelException(DEFAULT_CLOSE_MESSAGE)
+ override fun equals(other: Any?): Boolean = other is Closed && cause == other.cause
+ override fun hashCode(): Int = cause.hashCode()
+ override fun toString(): String = "Closed($cause)"
+ }
+
+ /**
+ * todo: consider making value/closed constructors public in the future.
+ */
+ internal companion object {
+ @Suppress("NOTHING_TO_INLINE")
+ internal inline fun <E> value(value: E): ValueOrClosed<E> =
+ ValueOrClosed(value)
+
+ @Suppress("NOTHING_TO_INLINE")
+ internal inline fun <E> closed(cause: Throwable?): ValueOrClosed<E> =
+ ValueOrClosed(Closed(cause))
+ }
+}
+
+/**
+ * Iterator for [ReceiveChannel]. Instances of this interface are *not thread-safe* and shall not be used
+ * from concurrent coroutines.
+ */
+public interface ChannelIterator<out E> {
+ /**
+ * Returns `true` if the channel has more elements, suspending the caller while this channel is empty,
+ * or returns `false` if the channel [isClosedForReceive][ReceiveChannel.isClosedForReceive] without cause.
+ * It throws the original [close][SendChannel.close] cause exception if the channel has _failed_.
+ *
+ * This function retrieves and removes the element from this channel for the subsequent invocation
+ * of [next].
+ *
+ * This suspending function is cancellable. If the [Job] of the current coroutine is cancelled or completed while this
+ * function is suspended, this function immediately resumes with [CancellationException].
+ *
+ * *Cancellation of suspended receive is atomic* -- when this function
+ * throws [CancellationException] it means that the element was not retrieved from this channel.
+ * As a side-effect of atomic cancellation, a thread-bound coroutine (to some UI thread, for example) may
+ * continue to execute even after it was cancelled from the same thread in the case when this receive operation
+ * was already resumed and the continuation was posted for execution to the thread's queue.
+ *
+ * Note that this function does not check for cancellation when it is not suspended.
+ * Use [yield] or [CoroutineScope.isActive] to periodically check for cancellation in tight loops if needed.
+ */
+ public suspend operator fun hasNext(): Boolean
+
+ @Deprecated(message = "Since 1.3.0, binary compatibility with versions <= 1.2.x", level = DeprecationLevel.HIDDEN)
+ @Suppress("INAPPLICABLE_JVM_NAME")
+ @JvmName("next")
+ public suspend fun next0(): E {
+ /*
+ * Before 1.3.0 the "next()" could have been used without invoking "hasNext" first and there were code samples
+ * demonstrating this behavior, so we preserve this logic for full binary backwards compatibility with previously
+ * compiled code.
+ */
+ if (!hasNext()) throw ClosedReceiveChannelException(DEFAULT_CLOSE_MESSAGE)
+ return next()
+ }
+
+ /**
+ * Retrieves the element from the current iterator previously removed from the channel by preceding call to [hasNext] or
+ * throws [IllegalStateException] if [hasNext] was not invoked.
+ * [next] should only be used in pair with [hasNext]:
+ * ```
+ * while (iterator.hasNext()) {
+ * val element = iterator.next()
+ * // ... handle element ...
+ * }
+ * ```
+ *
+ * This method throws [ClosedReceiveChannelException] if the channel [isClosedForReceive][ReceiveChannel.isClosedForReceive] without cause.
+ * It throws the original [close][SendChannel.close] cause exception if the channel has _failed_.
+ */
+ public operator fun next(): E
+}
+
+/**
+ * Channel is a non-blocking primitive for communication between sender using [SendChannel] and receiver using [ReceiveChannel].
+ * Conceptually, a channel is similar to [BlockingQueue][java.util.concurrent.BlockingQueue],
+ * but it has suspending operations instead of blocking ones and it can be closed.
+ *
+ * `Channel(capacity)` factory function is used to create channels of different kind depending on
+ * the value of `capacity` integer:
+ *
+ * * When `capacity` is 0 -- it creates `RendezvousChannel`.
+ * This channel does not have any buffer at all. An element is transferred from sender
+ * to receiver only when [send] and [receive] invocations meet in time (rendezvous), so [send] suspends
+ * until another coroutine invokes [receive] and [receive] suspends until another coroutine invokes [send].
+ *
+ * * When `capacity` is [Channel.UNLIMITED] -- it creates `LinkedListChannel`.
+ * This is a channel with linked-list buffer of a unlimited capacity (limited only by available memory).
+ * Sender to this channel never suspends and [offer] always returns `true`.
+ *
+ * * When `capacity` is [Channel.CONFLATED] -- it creates `ConflatedChannel`.
+ * This channel buffers at most one element and conflates all subsequent `send` and `offer` invocations,
+ * so that the receiver always gets the most recently sent element.
+ * Back-to-send sent elements are _conflated_ -- only the the most recently sent element is received,
+ * while previously sent elements **are lost**.
+ * Sender to this channel never suspends and [offer] always returns `true`.
+ *
+ * * When `capacity` is positive, but less than [UNLIMITED] -- it creates array-based channel with given capacity.
+ * This channel has an array buffer of a fixed `capacity`.
+ * Sender suspends only when buffer is full and receiver suspends only when buffer is empty.
+ */
+public interface Channel<E> : SendChannel<E>, ReceiveChannel<E> {
+ /**
+ * Constants for channel factory function `Channel()`.
+ */
+ public companion object Factory {
+ /**
+ * Requests channel with unlimited capacity buffer in `Channel(...)` factory function
+ */
+ public const val UNLIMITED = Int.MAX_VALUE
+
+ /**
+ * Requests rendezvous channel in `Channel(...)` factory function -- the `RendezvousChannel` gets created.
+ */
+ public const val RENDEZVOUS = 0
+
+ /**
+ * Requests conflated channel in `Channel(...)` factory function -- the `ConflatedChannel` gets created.
+ */
+ public const val CONFLATED = -1
+
+ /**
+ * Requests buffered channel with a default buffer capacity in `Channel(...)` factory function --
+ * the `ArrayChannel` gets created with a default capacity.
+ * This capacity is equal to 64 by default and can be overridden by setting
+ * [DEFAULT_BUFFER_PROPERTY_NAME] on JVM.
+ */
+ public const val BUFFERED = -2
+
+ // only for internal use, cannot be used with Channel(...)
+ internal const val OPTIONAL_CHANNEL = -3
+
+ /**
+ * Name of the property that defines the default channel capacity when
+ * [BUFFERED] is used as parameter in `Channel(...)` factory function.
+ */
+ public const val DEFAULT_BUFFER_PROPERTY_NAME = "kotlinx.coroutines.channels.defaultBuffer"
+
+ internal val CHANNEL_DEFAULT_CAPACITY = systemProp(DEFAULT_BUFFER_PROPERTY_NAME,
+ 64, 1, UNLIMITED - 1
+ )
+ }
+}
+
+/**
+ * Creates a channel with the specified buffer capacity (or without a buffer by default).
+ * See [Channel] interface documentation for details.
+ *
+ * @param capacity either a positive channel capacity or one of the constants defined in [Channel.Factory].
+ * @throws IllegalArgumentException when [capacity] < -2
+ */
+public fun <E> Channel(capacity: Int = RENDEZVOUS): Channel<E> =
+ when (capacity) {
+ RENDEZVOUS -> RendezvousChannel()
+ UNLIMITED -> LinkedListChannel()
+ CONFLATED -> ConflatedChannel()
+ BUFFERED -> ArrayChannel(CHANNEL_DEFAULT_CAPACITY)
+ else -> ArrayChannel(capacity)
+ }
+
+/**
+ * Indicates attempt to [send][SendChannel.send] on [isClosedForSend][SendChannel.isClosedForSend] channel
+ * that was closed without a cause. A _failed_ channel rethrows the original [close][SendChannel.close] cause
+ * exception on send attempts.
+ *
+ * This exception is a subclass of [IllegalStateException] because, conceptually, sender is responsible
+ * for closing the channel and not be trying to send anything after the channel was close. Attempts to
+ * send into the closed channel indicate logical error in the sender's code.
+ */
+public class ClosedSendChannelException(message: String?) : IllegalStateException(message)
+
+/**
+ * Indicates attempt to [receive][ReceiveChannel.receive] on [isClosedForReceive][ReceiveChannel.isClosedForReceive]
+ * channel that was closed without a cause. A _failed_ channel rethrows the original [close][SendChannel.close] cause
+ * exception on receive attempts.
+ *
+ * This exception is a subclass of [NoSuchElementException] to be consistent with plain collections.
+ */
+public class ClosedReceiveChannelException(message: String?) : NoSuchElementException(message) \ No newline at end of file