Top Description Interfaces Classes
[default module]

Package rx


Base reactive classes: Observable, Single and Completable; base reactive consumers; other common base interfaces.

A library that enables subscribing to and composing asynchronous events and callbacks.

The Observable/Observer interfaces and associated operators (in the .operations package) are inspired by and attempt to conform to the Reactive Rx library in Microsoft .Net.

More information can be found at http://msdn.microsoft.com/en-us/data/gg577609.

Compared with the Microsoft implementation:

Services which intend on exposing data asynchronously and wish to allow reactive processing and composition can implement the rx.Observable interface which then allows Observers to subscribe to them and receive events.

Usage examples can be found on the rx.Observable and rx.Subscriber classes.

Interface Summary

Modifier and TypeInterface and Description
public interface
CompletableEmitter

Abstraction over a CompletableSubscriber that gets either an onCompleted or onError signal and allows registering an cancellation/unsubscription callback.

public interface
CompletableSubscriber

Represents the subscription API callbacks when subscribing to a Completable instance.

public interface
Emitter<
the value type to emit
T
>

Abstraction over a RxJava Subscriber that allows associating a resource with it and exposes the current number of downstream requested amount.

public interface
Observer<
the type of item the Observer expects to observe
T
>

Provides a mechanism for receiving push-based notifications.

public interface
Producer

Interface that establishes a request-channel between an Observable and a Subscriber and allows the Subscriber to request a certain amount of items from the Observable (otherwise known as backpressure).

public interface
SingleEmitter<
the success value type
T
>

Abstraction over a SingleSubscriber that gets either an onSuccess or onError signal and allows registering an cancellation/unsubscription callback.

public interface
Subscription

Subscription returns from Observable#subscribe(Subscriber) to allow unsubscribing.

Class Summary

Modifier and TypeClass and Description
public class
BackpressureOverflow

Generic strategy and default implementations to deal with backpressure buffer overflows.

public class
Completable

Represents a deferred computation without any value but only indication for completion or exception.

public class
Notification<
the actual value type held by the Notification
T
>

An object representing a notification sent to an Observable.

public class
Observable<
the type of the items emitted by the Observable
T
>

The Observable class that implements the Reactive Pattern.

public abstract class
Scheduler

A Scheduler is an object that schedules units of work.

public class
Single<
the type of the item emitted by the Single
T
>

The Single class implements the Reactive Pattern for a single value response.

public abstract class
SingleSubscriber<
the type of item the SingleSubscriber expects to observe
T
>

Provides a mechanism for receiving push-based notifications.

public abstract class
Subscriber<
the type of items the Subscriber expects to observe
T
>

Provides a mechanism for receiving push-based notifications from Observables, and permits manual unsubscribing from these Observables.