Multi-keys, multi-producers, single-consumer event bus backed by kotlinx.coroutines.channels.Channels.
-
A Kotlin Multiplatform library that provides a simple event bus implementation using
kotlinx.coroutines.channels.Channels. This is useful for UI applications where you want to send events to communicate between different parts / scope of your application (e.g. send results from a screen to another screen). -
This bus is thread-safe to be used by multiple threads. It is safe to send events from multiple threads without any synchronization.
-
ChannelEvent.Keywill be used to identify a bus for a specific type of events. Each bus has aChannelto send events to and aFlowto receive events from. -
The
Channelis unbounded (Channel.UNLIMITED- default) or conflatedChannel.CONFLATED. TheFlowis cold and only one collector is allowed at a time. This make sure all events are consumed.
Author: Petrus Nguyễn Thái Học
Liked some of my work? Buy me a coffee (or more likely a beer)
0.x releasedocs: https://hoc081098.github.io/kotlin-channel-event-bus/docs/0.x- Snapshot docs: https://hoc081098.github.io/kotlin-channel-event-bus/docs/latest/
allprojects {
repositories {
[...]
mavenCentral()
}
}implementation("io.github.hoc081098:channel-event-bus:0.0.2")Snapshots of the development version are available in Sonatype's snapshots repository.
- Kotlin
allprojects {
repositories {
[...]
maven(url = "https://s01.oss.sonatype.org/content/repositories/snapshots/")
}
}
dependencies {
implementation("io.github.hoc081098:channel-event-bus:0.0.3-SNAPSHOT")
}- Groovy
allprojects {
repositories {
[...]
maven { url "https://s01.oss.sonatype.org/content/repositories/snapshots/" }
}
}
dependencies {
implementation 'io.github.hoc081098:channel-event-bus:0.0.3-SNAPSHOT'
}// Create your event type
data class AwesomeEvent(val payload: Int) : ChannelEvent<AwesomeEvent> {
override val key get() = Key
companion object Key : ChannelEventKey<AwesomeEvent>(AwesomeEvent::class)
}
// Create your bus instance
val bus = ChannelEventBus()
// Send events to the bus
bus.send(AwesomeEvent(1))
bus.send(AwesomeEvent(2))
bus.send(AwesomeEvent(3))
// Receive events from the bus
bus
.receiveAsFlow(AwesomeEvent) // or bus.receiveAsFlow(AwesomeEvent.Key) if you want to be explicit
.collect { e: AwesomeEvent -> println(e) }jvm/android.js(IR).Darwintargets:iosArm64,iosX64,iosSimulatorArm64.watchosArm32,watchosArm64,watchosX64,watchosSimulatorArm64,watchosDeviceArm64.tvosX64,tvosSimulatorArm64,tvosArm64.macosX64,macosArm64.
mingwX64linuxX64,linuxArm64.androidNativeArm32,androidNativeArm64,androidNativeX86,androidNativeX64.
-
Android Compose sample: an Android app using Compose UI to show how to use the library. It has two nested navigation graphs:
RegisterandHome.-
In
Register, we have 3 steps (3 screens) to allow user to input their information, step by step.-
A
RegisterSharedViewModel(bound toRegisternavigation graph scope) is used to hold the whole state of the registration process. It observes events from theChannelEventBusand update the state accordingly. -
Each step screen has a
ViewModelto hold the state of the screen, and will send events to theChannelEventBus, then theRegisterSharedViewModelwill receive those events and update the state.
-
-
In
Homenav graph, we have 2 screens:HomeandDetail.-
Homescreen has aHomeViewModelto hold the results received from theDetailscreen. Those result events are sent from theDetailscreen to theChannelEventBus, and theHomeViewModelwill receive those events and update the state. -
Detailscreen will send events to theChannelEventBuswhen user clicks on the button. TheHomeViewModelwill receive those events and update the state.
-
-
Screen_recording_20231203_155312.mp4
- Support more targets:
wasm(depends on supported targets bykotlinx.coroutines). - More samples.
- More docs.
- More tests.
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
![renovate[bot] avatar](https://avatars.githubusercontent.com/in/2740?v=4 "renovate[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent