Giter Site home page Giter Site logo

rxbus's Introduction

RxBus - An event bus by ReactiveX/RxJava/ReactiveX/RxAndroid

This is an event bus designed to allowing your application to communicate efficiently.

I have use it in many projects, and now i think maybe someone would like it, so i publish it.

RxBus support annotations(@produce/@subscribe), and it can provide you to produce/subscribe on other thread like MAIN_THREAD, NEW_THREAD, IO, COMPUTATION, TRAMPOLINE, IMMEDIATE, even the EXECUTOR and HANDLER thread, more in EventThread.

Also RxBus provide the event tag to define the event. The method's first (and only) parameter and tag defines the event type.

Thanks to:

square/otto

greenrobot/EventBus

Usage

Just 2 Steps:

STEP 1

Add dependency to your gradle file:

compile 'com.hwangjr.rxbus:rxbus:1.0.6'

Or maven:

<dependency>
  <groupId>com.hwangjr.rxbus</groupId>
  <artifactId>rxbus</artifactId>
  <version>1.0.6</version>
  <type>aar</type>
</dependency>

TIP: Maybe you also use the JakeWharton/timber to log your message, you may need to exclude the timber (from version 1.0.4, timber dependency update from AndroidKnife/Utils/timber to JakeWharton):

compile ('com.hwangjr.rxbus:rxbus:1.0.6') {
    exclude group: 'com.jakewharton.timber', module: 'timber'
}

en Snapshots of the development version are available in Sonatype's snapshots repository.

STEP 2

Just use the provided(Any Thread Enforce):

com.hwangjr.rxbus.RxBus

Or make RxBus instance is a better choice:

public static final class RxBus {
    private static Bus sBus;
    
    public static synchronized Bus get() {
        if (sBus == null) {
            sBus = new Bus();
        }
        return sBus;
    }
}

Add the code where you want to produce/subscribe events, and register and unregister the class.

public class MainActivity extends AppCompatActivity {
    ...
    
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        ...
        RxBus.get().register(this);
        ...
    }
    
    @Override
    protected void onDestroy() {
        ...
        RxBus.get().unregister(this);
        ...
    }
        
    @Subscribe
    public void eat(String food) {
        // purpose
    }
        
    @Subscribe(
        thread = EventThread.IO,
        tags = {
            @Tag(BusAction.EAT_MORE)
        }
    )
    public void eatMore(List<String> foods) {
        // purpose
    }
    
    @Produce
    public String produceFood() {
        return "This is bread!";
    }
    
    @Produce(
        thread = EventThread.IO,
        tags = {
            @Tag(BusAction.EAT_MORE)
        }
    )
    public List<String> produceMoreFood() {
        return Arrays.asList("This is breads!");
    }
    
    public void post() {
        RxBus.get().post(this);
    }
    
    public void postByTag() {
        RxBus.get().post(Constants.EventType.TAG_STORY, this);
    }
    ...
}

That is all done!

Lint

Features

  • JUnit test
  • Docs

History

Here is the CHANGELOG.

FAQ

Q: How to do pull requests?
A: Ensure good code quality and consistent formatting.

License

Copyright 2015 HwangJR, 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.

rxbus's People

Contributors

hwangjr avatar jasl avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.