core/pro.respawn.flowmvi.api.context/ShutdownContext

ShutdownContext

interface ShutdownContext<S : MVIState, I : MVIIntent, A : MVIAction> : ImmediateStateReceiver<S> , StoreLifecycle

The context in which the store may be shut down.

Provides a limited API to manipulate values that outlive the full PipelineContext.

Properties

abstract val config: StoreConfiguration<S>

The StoreConfiguration of this store

abstract val isActive: Boolean

Whether the Store is active (store is started or being started).

abstract val isStarted: Boolean

Whether the Store has started fully.

val <S : MVIState> StateProvider<S>.state: S

Obtain the current state in an unsafe manner.

abstract override val states: StateFlow<S>

A flow of states to be rendered by the subscriber.

Functions

abstract suspend fun awaitStartup()

Wait while the Store is started. If it is already started, returns immediately.

awaitUntilClosed

abstract suspend fun awaitUntilClosed()

Suspend until the store is closed

expect abstract fun close()

abstract suspend fun closeAndWait()

Await while the Store is fully closed.

abstract fun compareAndSet(old: S, new: S): Boolean

Directly compare and set the current state.

updateStateImmediate

@JvmName(name = "updateStateImmediateTyped")

inline fun <T : S, S : MVIState> ImmediateStateReceiver<S>.updateStateImmediate(transform: T.() -> S)

A typed overload of updateStateImmediate.

inline fun <S : MVIState> ImmediateStateReceiver<S>.updateStateImmediate(transform: S.() -> S)

A function that obtains current state and updates it atomically (in the thread context), and non-atomically in the coroutine context, which means it can cause races when you want to update states in parallel.