ReplaySubject

@FlowPreview()

class ReplaySubject<T> : AbstractFlow<T> , SubjectAPI<T>

Caches and replays some or all items to collectors.

Constructors

ReplaySubject

fun ReplaySubject()

Creates a ReplaySubject with an unbounded internal buffer caching all values received via emit.

ReplaySubject

fun ReplaySubject(maxSize: Int)

Creates a ReplaySubject that caches at most maxSize values to be replayed to late collectors.

ReplaySubject

fun ReplaySubject(maxTime: Long, unit: TimeUnit)

Creates a ReplaySubject that caches values at most for the given maxTime real-time duration and replays those upfront to late collectors.

ReplaySubject

fun ReplaySubject(maxSize: Int, maxTime: Long, unit: TimeUnit)

Creates a ReplaySubject that caches at most maxSize values at most for the given maxTime real-time duration and replays those upfront to late collectors.

ReplaySubject

fun ReplaySubject(maxSize: Int, maxTime: Long, unit: TimeUnit, timeSource: (TimeUnit) -> Long)

Creates a ReplaySubject that caches at most maxSize values at most for the given maxTime duration (measured via the custom timeSource) and replays those upfront to late collectors.

Functions

collect

suspend override fun collect(collector: FlowCollector<T>)

collectorCount

open override fun collectorCount(): Int

Returns the current number of collectors.

collectSafely

@FlowPreview()

open suspend override fun collectSafely(collector: FlowCollector<T>)

Accepts a collector and emits the cached values upfront and any subsequent value received by this ReplaySubject until the ReplaySubject gets terminated.

complete

open suspend override fun complete()

Indicate no further items will be produced.

emit

open suspend override fun emit(value: T)

Emit a value to all current collectors when they are ready.

emitError

open suspend override fun emitError(ex: Throwable)

Signal an Throwable to the collector.

hasCollectors

open override fun hasCollectors(): Boolean

Returns true if this PublishSubject has any collectors.