SendChannel

interface SendChannel<in E>

Sender's interface to Channel.

Functions

close
Link copied to clipboard
abstract fun close(cause: Throwable? = null): Boolean

Closes this channel. This is an idempotent operation — subsequent invocations of this function have no effect and return false. Conceptually, it sends a special "close token" over this channel.

invokeOnClose
Link copied to clipboard
abstract fun invokeOnClose(handler: (cause: Throwable?) -> Unit)

Registers a handler which is synchronously invoked once the channel is closed or the receiving side of this channel is cancelled. Only one handler can be attached to a channel during its lifetime. The handler is invoked when isClosedForSend starts to return true. If the channel is closed already, the handler is invoked immediately.

send
Link copied to clipboard
abstract suspend fun send(element: E)

Sends the specified element to this channel, suspending the caller while the buffer of this channel is full or if it does not exist, or throws an exception if the channel is closed for send (see close for details).

trySend
Link copied to clipboard
abstract fun trySend(element: E): ChannelResult<Unit>

Immediately adds the specified element to this channel, if this doesn't violate its capacity restrictions, and returns the successful result. Otherwise, returns failed or closed result. This is synchronous variant of send, which backs off in situations when send suspends or throws.

Properties

isClosedForSend
Link copied to clipboard
abstract val isClosedForSend: Boolean

Returns true if this channel was closed by an invocation of close. This means that calling send will result in an exception.

onSend
Link copied to clipboard
abstract val onSend: SelectClause2<E, SendChannel<E>>

Clause for the select expression of the send suspending function that selects when the element that is specified as the parameter is sent to the channel. When the clause is selected, the reference to this channel is passed into the corresponding block.

Inheritors

BroadcastChannel
Link copied to clipboard
Channel
Link copied to clipboard
ProducerScope
Link copied to clipboard

Extensions

trySendBlocking
Link copied to clipboard
fun <E> SendChannel<E>.trySendBlocking(element: E): ChannelResult<Unit>

Adds element to this channel, blocking the caller while this channel is full, and returning either successful result when the element was added, or failed result representing closed channel with a corresponding exception.

Sources

common source
Link copied to clipboard