NYBus - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #react #ai #golang #machine-learning #deep-learning #linux #java #awesome #awesome-list #ios #openai #open-source

NYBus

(★ 289)

NYBus (RxBus) - A pub-sub library for Android and Java applications

파일 탐색기

최종 버전 다운로드 (.zip)

- .gitignore
- build.gradle
- proguard-rules.pro
- nybus.png
- - gradle-wrapper.jar
  - gradle-wrapper.properties
- .gitignore
- build.gradle
- proguard-rules.pro
- upload.gradle
- .gitignore
- build.gradle
- .gitignore
- build.gradle
- .gitignore
- build.gradle
.gitignore
build.gradle
CONTRIBUTING.md
gradle.properties
gradlew
gradlew.bat
LICENSE
README.md
settings.gradle

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/amitshekhariitbhu/NYBus

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd NYBus

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Gradle (Java/Kotlin)

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
JDK (Java) Java/Kotlin 프로젝트를 빌드/실행하려면 필요합니다.
Gradle 레포에 포함된 gradlew(Gradle Wrapper)를 쓰면 Gradle을 따로 설치할 필요가 없습니다.

cd app

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

./gradlew build

Gradle로 빌드를 진행합니다.

✅ BUILD SUCCESSFUL 메시지가 뜨면 성공입니다. build/ 폴더에 결과물이 생성됩니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
<img alt="NYBus" src=https://raw.githubusercontent.com/amitshekhariitbhu/NYBus/master/assets/nybus.png />
</p>

# 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.