kotlinx-coroutines-core/kotlinx.coroutines.channels/BufferOverflow

BufferOverflow

enum BufferOverflow : Enum<BufferOverflow> (source)

A strategy for buffer overflow handling in channels and flows that controls what is going to be sacrificed on buffer overflow:

SUSPEND — the upstream that is sending or is emitting a value is suspended while the buffer is full.
DROP_OLDEST — the oldest value in the buffer is dropped on overflow, and the new value is added, all without suspending.
DROP_LATEST — the buffer remains unchanged on overflow, and the value that we were going to add gets discarded, all without suspending.

Entries

SUSPEND

Suspend on buffer overflow.

DROP_OLDEST

Drop the oldest value in the buffer on overflow, add the new value to the buffer, do not suspend.

DROP_LATEST

Leave the buffer unchanged on overflow, dropping the value that we were going to add, do not suspend.

Properties

entries

val entries: EnumEntries<BufferOverflow>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Functions

valueOf

fun valueOf(value: String): BufferOverflow

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<BufferOverflow>

Returns an array containing the constants of this enum type, in the order they're declared.