NYBus(RxBus) - A pub-sub library for Android and Java applications.
My Personal Blog - amitshekhar.me - High-quality content to learn Android concepts.
This pub-sub library NYBus(RxBus) uses RxJava(RxJava2) for creating RxBus(RxBus2). You must have used EventBus. NYBus is very similar to the EventBus. NYBus is implemented using RxJava(RxJava2).
Overview of NYBus(RxBus) pub-sub library
- NYBus is used for posting any type of event to subscribe class in Android and Java applications.
- NYBus also support channel to avoid the problem of event getting received at undesirable places.
- NYBus also support thread customization(thread in which the event should be posted).
- NYBus is built on RxJava(RxJava2).
Using NYBus(RxBus) Library in your application
Android
compile 'com.mindorks.nybus:nybus-android:1.0.0'
Java
compile 'com.mindorks.nybus:nybus-java:1.0.0'
To run all the test cases
gradlew connectedAndroidTest test
Simple Usage
Register on default channel
NYBus.get().register(this);
Unregister from default channel
NYBus.get().unregister(this);
Post on default channel
NYBus.get().post(event);
Receive on default channel
@Subscribe
public void onEvent(Event event) {
}
Usage with specific channel
Register on specific channel
NYBus.get().register(this, Channel.ONE);
Register on more than one channel
NYBus.get().register(this, Channel.ONE, Channel.TWO);
Unregister from channel
NYBus.get().unregister(this, Channel.ONE);
Unregister from more than one channel
NYBus.get().unregister(this, Channel.ONE, Channel.TWO);
Post on a specific channel
NYBus.get().post(event, Channel.ONE);
Receive on a specific channel
@Subscribe(channelId = Channel.ONE)
public void onEvent(Event event) {
}
Receive on more than one channel
@Subscribe(channelId = {Channel.ONE, Channel.TWO})
public void onEvent(Event event) {
}
Usage with specific thread
Receive on specific thread
@Subscribe(threadType = NYThread.MAIN)
public void onEvent(Event event) {
}
Receive on a specific channel and a specific thread
@Subscribe(channelId = Channel.ONE, threadType = NYThread.IO)
public void onEvent(Event event) {
}
Enable Logging
NYBus.get().enableLogging();
It will log: D/NYBus: No target found for the eventclass com.mindorks.Event
If this library helps you in anyway, show your love ❤️ by putting a ⭐ on this project ✌️
You can connect with me on:
License
Copyright (C) 2022 Amit Shekhar
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.
Contributing to NYBus
All pull requests are welcome, make sure to follow the contribution guidelines when you submit pull request.