Deprecated

Broadcast Channel API is obsolete since 1.5.0. It will be deprecated with warning in 1.6.0 and with error in 1.7.0. It is replaced with SharedFlow.

Since this library was based on BroadcastChannels, it is also now obsolete. If you are interested I have made a similar library using the new StateFlow API: https://github.com/Kosert/FlowBus

If you are still using ChannelBus, check out Migration guide

---

ChannelBus

ChannelBus is an event bus implementation for Android.

• Powered by Kotlin Coroutines and Channels
• Thread-aware
• Fully operable from Java code

Example

Subscribing

Most use cases will consist of subscribing in your Activity/Fragment onStart method and unsubscribing in onStop.

class SomeActivity : AppCompatActivity() {

    private val receiver by lazy { EventsReceiver() }

    override fun onStart() {
        super.onStart()
        receiver.subscribe { event: MyEvent ->
            // handle new event
        }
    }

    override fun onStop() {
        super.onStop()
        receiver.unsubscribeAll()
    }

Posting

Instance of any class can posted as an event.

GlobalBus.post(MyEvent())

For detailed documentation, check the wiki.

Include in your project

In your project root build.gradle:

allprojects {
    repositories {
        maven { url 'https://jitpack.io' }
    }
}

In your module's build.gradle:

dependencies {
    implementation 'com.github.Kosert:ChannelBus:0.3'
}

Optionally (this will prevent Android Studio from highlighting usages because of ExperimentalCoroutinesApi):

android {
    kotlinOptions.freeCompilerArgs += "-Xuse-experimental=kotlinx.coroutines.ExperimentalCoroutinesApi"
}

License

Copyright 2019 Robert Kosakowski

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.