Skip to content
This repository has been archived by the owner on Jun 20, 2024. It is now read-only.

darylteo/rxjava-promises

Repository files navigation

RxJava-Promises

Promises library for JVM based languages

IMPORTANT NOTE

Hi all! Unfortunately, this library was built at a stage where RxJava was not very mature, and my experience in OSS was quite poor, so here are some questions frequently asked.

Are you still maintaining this?

No I am not. However, many employers still ask for your GitHub profile to show some sort of self-driven initiative, so I leave this repository here publicly. If you have any need for changes, please fork.

Talking about Forks - what license is this under?

Yes, unfortunately, I had copied a Gradle template originally. Therefore, the artifacts being produced are indicated as being Apache licensed.

Please ignore it. For all source in this repository, everything is "do whatever you want with it", and provided as is.

Do you recommend anything else?

Yes! I have recently found RxJava to be highly adequate for more general use cases where one would have previously preferred a Promise. A PublishSubject is essentially what you want.

What is it?

Promises is a pattern for callback-based flow control. This particular implementation of Promises is useful in places where blocking calls are undesired.

Where to Start

  • If you wish to use RxJava-Promises as a standalone library, see RxJava-Promises.
  • If you wish to use RxJava-Promises as a vert.x Module, see Vertx-Promises.

Notes

Releases

Core v1.1.2 - As of core v1.1.2, jars are targetted at Java 1.6 to support Android. See #2 Core v1.2.0 - Removes inheritance from Observable<>. Updated to rxjava 0.19.6.

Versioning Information

As there is a close dependency between the two subset of projects, the versioning strategy will be as follows:

  • both groups of projects will always use the same major and minor versions.
  • revision numbers will remain individual to each group. For example: a release of vertx-promises:X.Y.? will always use rxjava-promises.core:X.Y.? in its dependencies.

Technical Details

This library implements most of the Promises/A+ spec. It is also based on Q for Node.JS, which adds additional conveniences such as reject and finally. Finally, it is built using the RxJava library.

This library is unlike other similar language based implementations (such as Futures, or Groovy Promise) as it is completely unblocking. It is designed to work with asynchronous-callback-heavy platforms. Furthermore, it has several additional classes that aims to improve the type-safety of Java-based usage, while minimising the verbosity by generics inferencing.

Vert.x

The primary motivation for this project is to provide a more convenient means of callback flow-control for the vert.x platform. However, I decided that it would be nice if this can be used in other places as well. Therefore, the project contains two separate groups of subprojects.

Future Work

rx.Observable<> Limitations

While built on the RxJava library, it currently does not fully support the polyglot nature of the library as it is still in flux. Once that work has stabilised, a working implementation can be released.

Promises/A+ spec

This implementation tries its best to fulfill all the points proposed in the Promises/A+ spec, but is still lacking in some areas. Work will continue to improve its conformance with the spec.

More languages

Only Java and Groovy are supported currently. More languages should come (if interest is high).

Overall Documentation and Testing Quality

This code-base is currently lacking in this area, and I hope I will improve this thoroughly in the future.

Documentation

View the README.md in each project for documentation.

About

Promises Implementation for JVM languages.

Resources

Stars

Watchers

Forks

Packages

No packages published