# Anadea_RxBus

**Repository Path**: HarmonyOS-tpc/Anadea_RxBus

## Basic Information

- **Project Name**: Anadea_RxBus
- **Description**: Event bus based on RxJava and optimized for OpenHarmony.
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 1
- **Created**: 2021-04-02
- **Last Updated**: 2023-04-17

## Categories & Tags

**Categories**: harmonyos-toolkit

**Tags**: None

## README

## RxBus
Event bus based on RxJava and optimized for OpenHarmony.

## Usage
Solution 1: 
local har package integration
1.Add the har package to the lib folder.
2.Add the following code to gradle of the entry:
```gradle
implementation fileTree(dir: 'libs', include: ['.jar', '.har'])
```
Solution 2:
```gradle
allprojects{
    repositories{
        mavenCentral()
    }
}
implementation 'io.openharmony.tpc.thirdlib:Anadea_RxBus:1.0.3'
```

## entry运行要求
通过DevEco studio,并下载OpenHarmonySDK
将项目中的build.gradle文件中dependencies→classpath版本改为对应的版本（即你的IDE新建项目中所用的版本）

## Init
We recommend obtaining the single instance of bus through injection or another appropriate mechanism.

Or get singleton like following:

```
Bus bus = BusProvider.getInstance();
```

#### Subscribing

To subscribe to an event, declare and annotate a method with @Subscribe. The method should be public and take only a single parameter.

```
@Subscribe
public void onEvent(SomeEvent event) {
    // TODO: Do something
}
```

You can also create subscription like following:

```
CustomSubscriber<SomeEvent> customSubscriber = bus.obtainSubscriber(SomeEvent.class,
    new Consumer<SomeEvent>() {
        @Override
        public void accept(SomeEvent someEvent) throws Exception {
            // TODO: Do something
        }
    })
    .withFilter(new Predicate<SomeEvent>() {
        @Override
        public boolean test(SomeEvent someEvent) throws Exception {
            return "Specific message".equals(someEvent.message);
        }
    })
    .withScheduler(Schedulers.trampoline());
```

#### Register and unregister your observer

To receive events, a class instance needs to register with the bus.

```
bus.register(this);
```

The customSubscriber also needs to register with the bus.

```
bus.registerSubscriber(this, customSubscriber);
```

Remember to also call the unregister method when appropriate.
```
bus.unregister(this);
```

#### Publishing

To publish a new event, call the post method:

```
bus.post(new SomeEvent("Message"));
```

ProGuard
-------

If you are using ProGuard, add the following lines to your ProGuard configuration file.

```
-keepattributes *Annotation*
-keepclassmembers class ** {
    @com.anadeainc.rxbus.Subscribe public *;
}
```

## License

    Copyright (C) 2017 Anadea Inc

    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.