io.reactivex.netty.protocol.http

Class UnicastContentSubject<T>

java.lang.Object

rx.Observable<R>

rx.subjects.Subject<T,T>

io.reactivex.netty.protocol.http.UnicastContentSubject<T>

All Implemented Interfaces:

rx.Observer<T>

public final class UnicastContentSubject<T>
extends rx.subjects.Subject<T,T>

A Subject implementation to be used by HttpClientResponse and HttpServerRequest.

Unicast

This implementation allows a single subscription as this buffers the content till subscription to solve the issue described in this github issue. If we allow multiple subscription and still maintain it as a cold observable i.e. which re-runs the stream on every subscription, we loose the control on the scope of this Observable as any code can hold the reference to this Observable at any point in time and hence subscribe to it at any time. This will eventually increase memory consumption as we will hold on to the content buffers for more time than required.

Multicast option

If at all it is required to allow multiple subscriptions to this Subject one should use a Observable.publish() operator.

Buffering

This subject will buffer all content till the first (one and only) subscriber arrives. In cases, when there are no subscriptions, this buffer may be held till infinity and hence can cause a memory leak in case of netty's ByteBuf which needs to be released explicitly. In order to avoid this leak, this subject provides a "no subscription timeout" which disposes this subject (calling disposeIfNotSubscribed() if it does not get a subscription in the configured timeout duration. The buffer is only utilized if there are any items emitted to this subject before a subscription arrives. After a subscription arrives, this subject becomes a pass through i.e. it does not buffer before sending the notifications.

Nested Class Summary

Nested classes/interfaces inherited from class rx.Observable

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

Method Summary

Modifier and Type	Method and Description
static <T> UnicastContentSubject<T>	create(long noSubscriptionTimeout, java.util.concurrent.TimeUnit timeUnit)
static <T> UnicastContentSubject<T>	create(long noSubscriptionTimeout, java.util.concurrent.TimeUnit timeUnit, rx.functions.Action0 onUnsubscribe)
static <T> UnicastContentSubject<T>	create(long noSubscriptionTimeout, java.util.concurrent.TimeUnit timeUnit, rx.Scheduler timeoutScheduler)
static <T> UnicastContentSubject<T>	create(long noSubscriptionTimeout, java.util.concurrent.TimeUnit timeUnit, rx.Scheduler timeoutScheduler, rx.functions.Action0 onUnsubscribe)
static <T> UnicastContentSubject<T>	createWithoutNoSubscriptionTimeout() Creates a new UnicastContentSubject without a no subscription timeout.
static <T> UnicastContentSubject<T>	createWithoutNoSubscriptionTimeout(rx.functions.Action0 onUnsubscribe) Creates a new UnicastContentSubject without a no subscription timeout.
boolean	disposeIfNotSubscribed() This will eagerly dispose this Subject without waiting for the no subscription timeout period, if configured.
boolean	hasObservers()
void	onCompleted()
void	onError(java.lang.Throwable e)
void	onNext(T t)
void	updateTimeoutIfNotScheduled(long noSubscriptionTimeout, java.util.concurrent.TimeUnit timeUnit)

Methods inherited from class rx.subjects.Subject

getThrowable, getValue, getValues, getValues, hasCompleted, hasThrowable, hasValue, toSerialized

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, countLong, create, debounce, debounce, debounce, defaultIfEmpty, defer, delay, delay, delay, delay, delaySubscription, delaySubscription, delaySubscription, dematerialize, distinct, distinct, distinctUntilChanged, distinctUntilChanged, doOnCompleted, doOnEach, doOnEach, doOnError, doOnNext, doOnRequest, doOnSubscribe, doOnTerminate, doOnUnsubscribe, elementAt, elementAtOrDefault, empty, error, exists, filter, finallyDo, first, first, firstOrDefault, firstOrDefault, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMapIterable, flatMapIterable, forEach, forEach, forEach, from, from, from, from, from, groupBy, groupBy, groupJoin, ignoreElements, interval, interval, isEmpty, join, just, just, just, just, just, just, just, just, just, just, last, last, lastOrDefault, lastOrDefault, lift, limit, map, materialize, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeWith, nest, never, observeOn, ofType, onBackpressureBlock, onBackpressureBlock, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureDrop, onBackpressureDrop, onErrorResumeNext, onErrorResumeNext, onErrorReturn, onExceptionResumeNext, publish, publish, 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, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, subscribe, subscribe, subscribe, subscribe, subscribe, subscribe, subscribeOn, switchIfEmpty, switchMap, switchOnNext, take, take, take, takeFirst, takeLast, takeLast, takeLast, takeLast, takeLast, takeLastBuffer, takeLastBuffer, takeLastBuffer, takeLastBuffer, takeLastBuffer, takeUntil, takeUntil, takeWhile, throttleFirst, throttleFirst, throttleLast, throttleLast, throttleWithTimeout, throttleWithTimeout, timeInterval, timeInterval, timeout, timeout, timeout, timeout, timeout, timeout, timeout, timeout, timer, timer, timer, timer, timestamp, timestamp, toBlocking, toList, toMap, toMap, toMap, toMultimap, toMultimap, toMultimap, toMultimap, toSortedList, toSortedList, toSortedList, toSortedList, unsafeSubscribe, unsubscribeOn, using, using, window, window, window, window, window, window, window, window, window, window, window, window, withLatestFrom, 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

createWithoutNoSubscriptionTimeout

public static <T> UnicastContentSubject<T> createWithoutNoSubscriptionTimeout(rx.functions.Action0 onUnsubscribe)

Creates a new UnicastContentSubject without a no subscription timeout. This can cause a memory leak in case no one ever subscribes to this subject. See UnicastContentSubject for details.

Type Parameters:

T - The type emitted and received by this subject.

Parameters:

onUnsubscribe - An action to be invoked when the sole subscriber to this Subject unsubscribes.

Returns:

The new instance of UnicastContentSubject

createWithoutNoSubscriptionTimeout

public static <T> UnicastContentSubject<T> createWithoutNoSubscriptionTimeout()

Creates a new UnicastContentSubject without a no subscription timeout. This can cause a memory leak in case no one ever subscribes to this subject. See UnicastContentSubject for details.

Type Parameters:

T - The type emitted and received by this subject.

Returns:

The new instance of UnicastContentSubject

create

public static <T> UnicastContentSubject<T> create(long noSubscriptionTimeout,
                                                  java.util.concurrent.TimeUnit timeUnit)

create

public static <T> UnicastContentSubject<T> create(long noSubscriptionTimeout,
                                                  java.util.concurrent.TimeUnit timeUnit,
                                                  rx.functions.Action0 onUnsubscribe)

create

public static <T> UnicastContentSubject<T> create(long noSubscriptionTimeout,
                                                  java.util.concurrent.TimeUnit timeUnit,
                                                  rx.Scheduler timeoutScheduler)

create

public static <T> UnicastContentSubject<T> create(long noSubscriptionTimeout,
                                                  java.util.concurrent.TimeUnit timeUnit,
                                                  rx.Scheduler timeoutScheduler,
                                                  rx.functions.Action0 onUnsubscribe)

disposeIfNotSubscribed

public boolean disposeIfNotSubscribed()

This will eagerly dispose this Subject without waiting for the no subscription timeout period, if configured. This must be invoked when the caller is sure that no one will subscribe to this subject. Any subscriber after this call will receive an error that the subject is disposed.

Returns:

true if the subject was disposed by this call (if and only if there was no subscription).

updateTimeoutIfNotScheduled

public void updateTimeoutIfNotScheduled(long noSubscriptionTimeout,
                                        java.util.concurrent.TimeUnit timeUnit)

onCompleted

public void onCompleted()

onError

public void onError(java.lang.Throwable e)

onNext

public void onNext(T t)

hasObservers

public boolean hasObservers()

Specified by:

hasObservers in class rx.subjects.Subject<T,T>