SendChannel
interface SendChannel<in E>
(source)Platform and version requirements: JVM
Sender’s interface to Channel.
Properties
abstract val isClosedForSend: Boolean Returns |
|
abstract val isFull: Boolean Returns |
|
abstract val onSend: SelectClause2<E, SendChannel<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. |
Functions
Closes this channel with an optional exceptional cause.
This is an idempotent operation – repeated invocations of this function have no effect and return |
|
Adds element into this queue if it is possible to do so immediately without violating capacity restrictions
and returns |
|
Adds element into to this channel, suspending the caller while this channel isFull, or throws exception if the channel isClosedForSend (see close for details). |
Extension Functions
fun <E> SendChannel<E>.sendBlocking(element: E): Unit Adds element into to this channel, blocking the caller while this channel Channel.isFull, or throws exception if the channel Channel.isClosedForSend (see Channel.close for details). |
Inheritors
abstract class AbstractSendChannel<E> : SendChannel<E> Abstract send channel. It is a base class for all send channel implementations. |
|
interface BroadcastChannel<E> : SendChannel<E> Broadcast channel is a non-blocking primitive for communication between the sender and multiple receivers that subscribe for the elements using openSubscription function and unsubscribe using SubscriptionReceiveChannel.close function. |
|
interface Channel<E> : SendChannel<E>, ReceiveChannel<E> Channel is a non-blocking primitive for communication between sender using SendChannel and receiver using ReceiveChannel. Conceptually, a channel is similar to BlockingQueue, but it has suspending operations instead of blocking ones and it can be closed. |
|
interface ProducerScope<in E> : Scope for produce coroutine builder. |