orbit-core/org.orbitmvi.orbit.internal/RealContainer

RealContainer

class RealContainer<STATE : Any, SIDE_EFFECT : Any>(initialState: STATE, parentScope: CoroutineScope, val settings: RealSettings, subscribedCounterOverride: SubscribedCounter? = null) : Container<STATE, SIDE_EFFECT>

Constructors

RealContainer

constructor(initialState: STATE, parentScope: CoroutineScope, settings: RealSettings, subscribedCounterOverride: SubscribedCounter? = null)

Properties

refCountSideEffectFlow

open override val refCountSideEffectFlow: Flow<SIDE_EFFECT>

A version of sideEffectFlow ref-counted for the repeatOnSubscription operator. Do not use when subscribing to state updates within your ContainerHost.

refCountStateFlow

open override val refCountStateFlow: StateFlow<STATE>

A version of stateFlow ref-counted for the repeatOnSubscription operator. Do not use when subscribing to state updates within your ContainerHost.

scope

open override val scope: CoroutineScope

settings

open override val settings: RealSettings

Settings that the container was set up with

sideEffectFlow

open override val sideEffectFlow: Flow<SIDE_EFFECT>

A Flow of one-off side effects posted from Container. Caches side effects when there are no collectors. The size of the cache can be controlled via SettingsBuilder and determines if and when the orbit thread suspends when you post a side effect. The default is unlimited. You don't have to touch this unless you are posting many side effects which could result in OutOfMemoryError.

stateFlow

open override val stateFlow: StateFlow<STATE>

A StateFlow of state updates. Emits the latest state upon subscription and serves only distinct values (through equality comparison).

Functions

cancel

open override fun cancel()

Cancels the container scope and all intents in progress.

inlineOrbit

open suspend override fun inlineOrbit(orbitIntent: suspend ContainerContext<STATE, SIDE_EFFECT>.() -> Unit)

Executes an orbit intent inline, circumventing orbit's dispatching. The intents are built in the ContainerHost using your chosen syntax.

joinIntents

open suspend override fun joinIntents()

Joins all in progress intents in the container. This suspends until all intents have completed.

orbit

open suspend override fun orbit(orbitIntent: suspend ContainerContext<STATE, SIDE_EFFECT>.() -> Unit): Job

Executes an orbit intent. The intents are built in the ContainerHost using your chosen syntax.