https://github.com/Anadea/RxBus
Event bus based on RxJava
https://github.com/Anadea/RxBus
android android-library bus event-bus rxandroid rxjava
Last synced: about 14 hours ago
JSON representation
Event bus based on RxJava
- Host: GitHub
- URL: https://github.com/Anadea/RxBus
- Owner: Anadea
- License: apache-2.0
- Created: 2017-01-27T13:08:12.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-08-01T07:34:39.000Z (over 8 years ago)
- Last Synced: 2026-01-14T04:52:01.054Z (3 months ago)
- Topics: android, android-library, bus, event-bus, rxandroid, rxjava
- Language: Java
- Size: 115 KB
- Stars: 59
- Watchers: 17
- Forks: 9
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-java - RxBus
README
RxBus
===========
Event bus based on RxJava and optimized for Android.
Usage
-------
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 customSubscriber = bus.obtainSubscriber(SomeEvent.class,
new Consumer() {
@Override
public void accept(SomeEvent someEvent) throws Exception {
// TODO: Do something
}
})
.withFilter(new Predicate() {
@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"));
```
#### Add RxBus to your project
Gradle:
```
compile 'com.github.anadea:rxbus:1.0.1'
```
Maven:
```
com.github.anadea
rxbus
1.0.1
pom
```
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.