com.github.davidmoten.rx2

Class Observables

java.lang.Object

com.github.davidmoten.rx2.Observables

public final class Observables
extends Object

Method Summary

Modifier and Type	Method and Description
static <T> CachedObservable<T>	cache(io.reactivex.Observable<T> source) Returns a cached Flowable like Flowable.cache() except that the cache can be reset by calling CachedFlowable.reset().
static <T> io.reactivex.Observable<T>	cache(io.reactivex.Observable<T> source, long duration, TimeUnit unit, io.reactivex.Scheduler.Worker worker) Returns a cached Observable like Observable.cache() except that the cache can be reset by calling CachedObservable.reset() and the cache will be automatically reset an interval after first subscription (or first subscription after reset).
static <T> CloseableObservableWithReset<T>	cache(io.reactivex.Observable<T> source, long duration, TimeUnit unit, io.reactivex.Scheduler scheduler) Returns a cached Observable like Observable.cache() except that the cache may be reset by the user calling CloseableObservableWithReset.reset().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

cache

public static <T> CachedObservable<T> cache(io.reactivex.Observable<T> source)

Returns a cached Flowable like Flowable.cache() except that the cache can be reset by calling CachedFlowable.reset().

Type Parameters:

T - the generic type of the source

Parameters:

source - the observable to be cached.

Returns:

a cached observable whose cache can be reset.

cache

public static <T> io.reactivex.Observable<T> cache(io.reactivex.Observable<T> source,
                                                   long duration,
                                                   TimeUnit unit,
                                                   io.reactivex.Scheduler.Worker worker)

Returns a cached Observable like Observable.cache() except that the cache can be reset by calling CachedObservable.reset() and the cache will be automatically reset an interval after first subscription (or first subscription after reset). The interval is defined by duration and unit .

Type Parameters:

T - the generic type of the source

Parameters:

source - the source observable

duration - duration till next reset

unit - units corresponding to the duration

worker - worker to use for scheduling reset. Don't forget to unsubscribe the worker when no longer required.

Returns:

cached observable that resets regularly on a time interval

cache

public static <T> CloseableObservableWithReset<T> cache(io.reactivex.Observable<T> source,
                                                        long duration,
                                                        TimeUnit unit,
                                                        io.reactivex.Scheduler scheduler)

Returns a cached Observable like Observable.cache() except that the cache may be reset by the user calling CloseableObservableWithReset.reset().

Type Parameters:

T - generic type of source observable

Parameters:

source - the source observable

duration - duration till next reset

unit - units corresponding to the duration

scheduler - scheduler to use for scheduling reset.

Returns:

CloseableObservableWithReset that should be closed once finished to prevent worker memory leak.