module-flowbus/dev.racci.minix.flowbus/FlowBus

FlowBus

@API(status = API.Status.EXPERIMENTAL, since = "5.0.0")

open class FlowBus

This class holds all state flows and handles event posting. You can use the Koin singleton that is just plain instance of this class or create your own implementation.

Constructors

FlowBus

fun FlowBus()

Functions

dropAll

fun dropAll()

Removes all retained events

dropEvent

fun <T : Any> dropEvent(clazz: KClass<T>)

Removes retained event of type clazz

forEvent

@API(status = API.Status.INTERNAL)

open fun <T : Any> forEvent(clazz: KClass<out T>): RendezvousStateFlow<T?>

getFlow

fun <T : Any> getFlow(clazz: KClass<T>): Flow<T>

Gets a Flow for events of the given type.

getLastEvent

fun <T : Any> getLastEvent(clazz: KClass<T>): T?

Returns last posted event that was instance of clazz or null if no event of the given type is retained.

post

fun <T : Any> post(event: T, retain: Boolean = false)

Posts a new event to StateFlow of the event type.

postDeferred

suspend fun <T : Any> postDeferred(event: T, retain: Boolean = false): Deferred<Unit>

postLazy

inline fun <T : Any> postLazy(retain: Boolean = false, lazyEvent: () -> T)

Extensions

dropEvent

inline fun <T : Any> FlowBus.dropEvent()

getFlow

inline fun <T : Any> FlowBus.getFlow(): Flow<T>

getLastEvent

inline fun <T : Any> FlowBus.getLastEvent(): T?