RealContainer
class RealContainer<STATE : Any, SIDE_EFFECT : Any>(initialState: STATE, parentScope: CoroutineScope, val settings: RealSettings, subscribedCounterOverride: SubscribedCounter? = null) : Container<STATE, SIDE_EFFECT>
Constructors
Link copied to clipboard
constructor(initialState: STATE, parentScope: CoroutineScope, settings: RealSettings, subscribedCounterOverride: SubscribedCounter? = null)
Functions
Link copied to clipboard
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.
Link copied to clipboard
Joins all in progress intents in the container. This suspends until all intents have completed.
Link copied to clipboard
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.
Properties
Link copied to clipboard
Settings that the container was set up with
Link copied to clipboard
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
.