AbstractSendChannel

abstract class AbstractSendChannel<E> : SendChannel<E>

Abstract send channel. It is a base class for all send channel implementations.

Constructors

<init>

AbstractSendChannel()

Abstract send channel. It is a base class for all send channel implementations.

Properties

bufferDebugString

open val bufferDebugString: String

isClosedForSend

val isClosedForSend: Boolean

Returns true if this channel was closed by invocation of close and thus the send and offer attempts throws exception.

isFull

val isFull: Boolean

Returns true if the channel is full (out of capacity) and the send attempt will suspend. This function returns false for isClosedForSend channel.

onSend

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

afterClose

open fun afterClose(cause: Throwable?): Unit

Invoked after successful close.

close

open fun close(cause: Throwable?): Boolean

Closes this channel with an optional exceptional cause. This is an idempotent operation – repeated invocations of this function have no effect and return false. Conceptually, its sends a special “close token” over this channel.

invokeOnClose

open fun invokeOnClose(handler: Handler): Unit

Registers handler which is synchronously invoked once the channel is closed or receiving side of this channel is cancelled. 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.

offer

fun offer(element: E): Boolean

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).

send

suspend fun send(element: E): Unit

Adds element into to this channel, suspending the caller while this channel isFull, or throws exception if the channel isClosedForSend (see close for details).

toString

open fun toString(): String

Extension Functions

sendBlocking

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

AbstractChannel

abstract class AbstractChannel<E> : 
    AbstractSendChannel<E>,
    Channel<E>

Abstract send/receive channel. It is a base class for all channel implementations.

ArrayBroadcastChannel

class ArrayBroadcastChannel<E> : 
    AbstractSendChannel<E>,
    BroadcastChannel<E>

Broadcast channel with array buffer of a fixed capacity. Sender suspends only when buffer is full due to one of the receives being slow to consume and receiver suspends only when buffer is empty.