MutableSharedFlow

fun <T> MutableSharedFlow(replay: Int = 0, extraBufferCapacity: Int = 0, onBufferOverflow: BufferOverflow = BufferOverflow.SUSPEND): MutableSharedFlow<T>

Creates a MutableSharedFlow with the given configuration parameters.

This function throws IllegalArgumentException on unsupported values of parameters or combinations thereof.

Parameters

replay

the number of values replayed to new subscribers (cannot be negative, defaults to zero).

extraBufferCapacity

the number of values buffered in addition to replay. emit does not suspend while there is a buffer space remaining (optional, cannot be negative, defaults to zero).

onBufferOverflow

configures an emit action on buffer overflow. Optional, defaults to suspending attempts to emit a value. Values other than BufferOverflow.SUSPEND are supported only when replay > 0 or extraBufferCapacity > 0. Buffer overflow can happen only when there is at least one subscriber that is not ready to accept the new value. In the absence of subscribers only the most recent replay values are stored and the buffer overflow behavior is never triggered and has no effect.

Sources

common source
Link copied to clipboard