rx.internal.operators

Class BufferUntilSubscriber<T>

java.lang.Object

rx.Observable<R>

rx.subjects.Subject<T,T>

rx.internal.operators.BufferUntilSubscriber<T>

Type Parameters:

T - the type of the items to be buffered

All Implemented Interfaces:

Observer<T>

public class BufferUntilSubscriber<T>
extends Subject<T,T>

A solution to the "time gap" problem that occurs with groupBy and pivot.

This currently has temporary unbounded buffers. It needs to become bounded and then do one of two things:

1. blow up and make the user do something about it
2. work with the backpressure solution ... still to be implemented (such as co-routines)

Generally the buffer should be very short lived (milliseconds) and then stops being involved. It can become a memory leak though if a GroupedObservable backed by this class is emitted but never subscribed to (such as filtered out). In that case, either a time-bomb to throw away the buffer, or just blowing up and making the user do something about it is needed.

For example, to filter out GroupedObservables, perhaps they need a silent subscribe() on them to just blackhole the data.

This is an initial start at solving this problem and solves the immediate problem of groupBy and pivot and trades off the possibility of memory leak for deterministic functionality.

See Also:

the Github issue describing the time gap problem

Nested Class Summary

Nested classes/interfaces inherited from class rx.Observable

Observable.OnSubscribe<T>, Observable.OnSubscribeFunc<T>, Observable.Operator<R,T>, Observable.Transformer<T,R>

Method Summary

Methods

Modifier and Type	Method and Description
static <T> BufferUntilSubscriber<T>	create()
void	onCompleted() Notifies the Observer that the Observable has finished sending push-based notifications.
void	onError(java.lang.Throwable e) Notifies the Observer that the Observable has experienced an error condition.
void	onNext(T t) Provides the Observer with a new item to observe.

Methods inherited from class rx.Observable

all, amb, amb, amb, amb, amb, amb, amb, amb, amb, ambWith, asObservable, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, cache, cache, cast, collect, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, compose, concat, concat, concat, concat, concat, concat, concat, concat, concat, concatMap, concatWith, contains, count, create, create, debounce, debounce, debounce, defaultIfEmpty, defer, delay, delay, delay, delay, delaySubscription, delaySubscription, dematerialize, distinct, distinct, distinctUntilChanged, distinctUntilChanged, doOnCompleted, doOnEach, doOnEach, doOnError, doOnNext, doOnSubscribe, doOnTerminate, doOnUnsubscribe, elementAt, elementAtOrDefault, empty, empty, error, error, exists, filter, finallyDo, first, first, firstOrDefault, firstOrDefault, flatMap, flatMap, flatMap, flatMapIterable, flatMapIterable, forEach, forEach, forEach, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, groupBy, groupBy, groupByUntil, groupByUntil, groupJoin, ignoreElements, interval, interval, isEmpty, join, just, just, just, just, just, just, just, just, just, just, last, last, lastOrDefault, lastOrDefault, lift, limit, longCount, map, materialize, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeMap, mergeMap, mergeMap, mergeMapIterable, mergeMapIterable, mergeWith, multicast, multicast, multicast, nest, never, observeOn, ofType, onBackpressureBuffer, onBackpressureDrop, onErrorFlatMap, onErrorResumeNext, onErrorResumeNext, onErrorReturn, onExceptionResumeNext, parallel, parallel, parallelMerge, parallelMerge, publish, publish, publish, publish, publishLast, publishLast, range, range, reduce, reduce, repeat, repeat, repeat, repeat, repeatWhen, repeatWhen, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, retry, retry, retry, retryWhen, retryWhen, sample, sample, sample, scan, scan, sequenceEqual, sequenceEqual, serialize, share, single, single, singleOrDefault, singleOrDefault, skip, skip, skip, skipLast, skipLast, skipLast, skipUntil, skipWhile, skipWhileWithIndex, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, subscribe, subscribe, subscribe, subscribe, subscribe, subscribe, subscribeOn, switchMap, switchOnNext, take, take, take, takeFirst, takeLast, takeLast, takeLast, takeLast, takeLast, takeLastBuffer, takeLastBuffer, takeLastBuffer, takeLastBuffer, takeLastBuffer, takeUntil, takeWhile, takeWhileWithIndex, throttleFirst, throttleFirst, throttleLast, throttleLast, throttleWithTimeout, throttleWithTimeout, timeInterval, timeInterval, timeout, timeout, timeout, timeout, timeout, timeout, timeout, timeout, timer, timer, timer, timer, timestamp, timestamp, toBlocking, toBlockingObservable, toList, toMap, toMap, toMap, toMultimap, toMultimap, toMultimap, toMultimap, toSortedList, toSortedList, unsafeSubscribe, unsubscribeOn, using, using, window, window, window, window, window, window, window, window, window, window, window, window, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zipWith, zipWith

Methods inherited from class java.lang.Object

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

Method Detail

create

public static <T> BufferUntilSubscriber<T> create()

Returns:

onCompleted

public void onCompleted()

Description copied from interface: Observer

Notifies the Observer that the Observable has finished sending push-based notifications.

The Observable will not call this method if it calls Observer.onError(java.lang.Throwable).

onError

public void onError(java.lang.Throwable e)

Description copied from interface: Observer

Notifies the Observer that the Observable has experienced an error condition.

If the Observable calls this method, it will not thereafter call Observer.onNext(T) or Observer.onCompleted().

Parameters:

e - the exception encountered by the Observable

onNext

public void onNext(T t)

Description copied from interface: Observer

Provides the Observer with a new item to observe.

The Observable may call this closure 0 or more times.

The Observable will not call this closure again after it calls either Observer.onCompleted() or Observer.onError(java.lang.Throwable).

Parameters:

t - the item emitted by the Observable