Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MindorksOpenSource/NYBus
NYBus (RxBus) - A pub-sub library for Android and Java applications
https://github.com/MindorksOpenSource/NYBus
android eventbus eventbus-library java-application pub pub-sub publisher pubsub rxbus rxbus2 rxjava rxjava-android rxjava2 subscriber
Last synced: about 17 hours ago
JSON representation
NYBus (RxBus) - A pub-sub library for Android and Java applications
- Host: GitHub
- URL: https://github.com/MindorksOpenSource/NYBus
- Owner: amitshekhariitbhu
- License: apache-2.0
- Created: 2017-08-14T07:12:19.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-18T19:21:02.000Z (5 months ago)
- Last Synced: 2024-10-30T02:52:43.802Z (2 months ago)
- Topics: android, eventbus, eventbus-library, java-application, pub, pub-sub, publisher, pubsub, rxbus, rxbus2, rxjava, rxjava-android, rxjava2, subscriber
- Language: Java
- Homepage: https://outcomeschool.com
- Size: 389 KB
- Stars: 288
- Watchers: 24
- Forks: 51
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# NYBus(RxBus) - A pub-sub library for Android and Java applications.
## [Outcome School Blog](https://outcomeschool.com/blog) - 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
Add this in your `settings.gradle`:
```groovy
maven { url 'https://jitpack.io' }
```
If you are using `settings.gradle.kts`, add the following:
```kotlin
maven { setUrl("https://jitpack.io") }
```
## Android
Add this in your `build.gradle`
```groovy
implementation 'com.github.amitshekhariitbhu.NYBus:nybus-android:1.0.0'
```
If you are using `build.gradle.kts`, add the following:
```kotlin
implementation("com.github.amitshekhariitbhu.NYBus:nybus-android:1.0.0")
```
## Java
Add this in your `build.gradle`
```groovy
implementation 'com.github.amitshekhariitbhu.NYBus:nybus-java:1.0.0'
```
If you are using `build.gradle.kts`, add the following:
```kotlin
implementation("com.github.amitshekhariitbhu.NYBus:nybus-java:1.0.0")
```
## To run all the test cases
```groovy
gradlew connectedAndroidTest test
```
## Simple Usage
### Register on default channel
```java
NYBus.get().register(this);
```
### Unregister from default channel
```java
NYBus.get().unregister(this);
```
### Post on default channel
```java
NYBus.get().post(event);
```
### Receive on default channel
```java
@Subscribe
public void onEvent(Event event) {
}
```
## Usage with specific channel
### Register on specific channel
```java
NYBus.get().register(this, Channel.ONE);
```
### Register on more than one channel
```java
NYBus.get().register(this, Channel.ONE, Channel.TWO);
```
### Unregister from channel
```java
NYBus.get().unregister(this, Channel.ONE);
```
### Unregister from more than one channel
```java
NYBus.get().unregister(this, Channel.ONE, Channel.TWO);
```
### Post on a specific channel
```java
NYBus.get().post(event, Channel.ONE);
```
### Receive on a specific channel
```java
@Subscribe(channelId = Channel.ONE)
public void onEvent(Event event) {
}
```
### Receive on more than one channel
```java
@Subscribe(channelId = {Channel.ONE, Channel.TWO})
public void onEvent(Event event) {
}
```
## Usage with specific thread
### Receive on specific thread
```java
@Subscribe(threadType = NYThread.MAIN)
public void onEvent(Event event) {
}
```
### Receive on a specific channel and a specific thread
```java
@Subscribe(channelId = Channel.ONE, threadType = NYThread.IO)
public void onEvent(Event event) {
}
```
### Enable Logging
```java
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 :heart: by putting a :star: on this project :v:
You can connect with me on:
- [Twitter](https://twitter.com/amitiitbhu)
- [LinkedIn](https://www.linkedin.com/in/amit-shekhar-iitbhu)
- [GitHub](https://github.com/amitshekhariitbhu)
- [Facebook](https://www.facebook.com/amit.shekhar.iitbhu)
[**Read all of our blogs here.**](https://outcomeschool.com/blog)
### License
```
Copyright (C) 2024 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](CONTRIBUTING.md)
when you submit pull request.