redukt-core/com.daftmobile.redukt.core.coroutines/SingleForegroundJobRegistry

SingleForegroundJobRegistry

class SingleForegroundJobRegistry(job: Job? = null) : ForegroundJobRegistry

A ForegroundJobRegistry that allows to register only one Job at once. Repeated call to a register without a consumeOrNull results in an exception.

Constructors

SingleForegroundJobRegistry

fun SingleForegroundJobRegistry(job: Job? = null)

Functions

open override fun consume(): Job

Returns registered foreground job or throws.

open override fun consumeOrNull(): Job?

Returns registered foreground job or null.

open override fun <T : DispatchClosure.Element> find(key: DispatchClosure.Key<T>): T?

Returns Element associated with the key or null.

open operator override fun <T : DispatchClosure.Element> get(key: DispatchClosure.Key<T>): T

Returns Element associated with the key or throws MissingClosureElementException.

open operator override fun minus(key: DispatchClosure.Key<*>): DispatchClosure

Returns a closure without the element with a given key

open operator fun plus(closure: DispatchClosure): DispatchClosure

Combines this closure with incoming closure. If both closures contain elements with the same keys, the ones from the incoming closure remain.

open override fun register(job: Job)

Registers a foreground job.

open override fun scatter(): Map<DispatchClosure.Key<*>, DispatchClosure.Element>

Returns elements form this DispatchClosure as a Map.

open override fun toString(): String

Properties

open override val key: ForegroundJobRegistry.Key

Key of this element.

Extensions

fun <T : DispatchClosure.Element> DispatchClosure.findOrElse(key: DispatchClosure.Key<T>, value: T): T

launchForeground

fun DispatchClosure.launchForeground(context: CoroutineContext = EmptyCoroutineContext, start: CoroutineStart = CoroutineStart.DEFAULT, block: suspend CoroutineScope.() -> Unit): Job

Launches a foreground job using this closure. By default, it's launched in a scope provided by DispatchCoroutineScope. This behaviour might be changed by dispatchJobIn or joinDispatchJob. Because this function uses local closure, calling it outside dispatch should not be done, because it might result in unexpected behaviour.

val DispatchClosure.local: DispatchClosure

Returns this closure with local changes.

inline fun DispatchClosure.registeringJob(closure: DispatchClosure = EmptyDispatchClosure, newFrame: Boolean = false, block: DispatchClosure.() -> Unit): Job

Runs block that must register a foreground job. It adds SingleForegroundJobRegistry to local closure to allow proper job registration. Local closure change creates a new frame if newFrame is true.

withLocalClosure

inline fun <T> DispatchClosure.withLocalClosure(closure: DispatchClosure, newFrame: Boolean = false, block: DispatchClosure.() -> T): T

Changes LocalClosureContainer with a given closure for a time of block execution.