RxJava 2 2.2.21 · io.reactivex.observables.ConnectableObservable

Constructor Summary

Access	Constructor and Description
public	ConnectableObservable()

Method Summary

Modifier and Type	Method and Description
public Observable<T>	Returns: an Observable that automatically connects to this ConnectableObservable when the first Observer subscribes autoConnect() Returns an Observable that automatically connects (at most once) to this ConnectableObservable when the first Observer subscribes.
public Observable<T>	Returns: an Observable that automatically connects to this ConnectableObservable when the specified number of Subscribers subscribe to it autoConnect(int the number of subscribers to await before calling connect on the ConnectableObservable. A non-positive value indicates an immediate connection. numberOfSubscribers) Returns an Observable that automatically connects (at most once) to this ConnectableObservable when the specified number of Observers subscribe to it.
public Observable<T>	Returns: an Observable that automatically connects to this ConnectableObservable when the specified number of Subscribers subscribe to it and calls the specified callback with the Subscription associated with the established connection autoConnect(int the number of subscribers to await before calling connect on the ConnectableObservable. A non-positive value indicates an immediate connection. numberOfSubscribers, Consumer<? super Disposable> the callback Consumer that will receive the Subscription representing the established connection connection) Returns an Observable that automatically connects (at most once) to this ConnectableObservable when the specified number of Subscribers subscribe to it and calls the specified callback with the Subscription associated with the established connection.
public abstract void	connect(Consumer<? super Disposable> the action that receives the connection subscription before the subscription to source happens allowing the caller to synchronously disconnect a synchronous source connection) Instructs the `ConnectableObservable` to begin emitting the items from its underlying `Observable` to its `Observer`s.
public final Disposable	Returns: the subscription representing the connection connect() Instructs the `ConnectableObservable` to begin emitting the items from its underlying `Observable` to its `Observer`s.
private ConnectableObservable<T>	Returns: the ConnectableObservable to work with onRefCount() Apply a workaround for a race condition with the regular publish().refCount() so that racing observers and refCount won't hang.
public Observable<T>	Returns: an `Observable` refCount() Returns an `Observable` that stays connected to this `ConnectableObservable` as long as there is at least one subscription to this `ConnectableObservable`.
public final Observable<T>	Returns: the new Observable instance refCount(int the number of subscribers required to connect to the upstream subscriberCount) Connects to the upstream `ConnectableObservable` if the number of subscribed subscriber reaches the specified count and disconnect if all subscribers have unsubscribed.
public final Observable<T>	Returns: the new Observable instance refCount(long the time to wait before disconnecting after all subscribers unsubscribed timeout, TimeUnit the time unit of the timeout unit) Connects to the upstream `ConnectableObservable` if the number of subscribed subscriber reaches 1 and disconnect after the specified timeout if all subscribers have unsubscribed.
public final Observable<T>	Returns: the new Observable instance refCount(long the time to wait before disconnecting after all subscribers unsubscribed timeout, TimeUnit the time unit of the timeout unit, Scheduler the target scheduler to wait on before disconnecting scheduler) Connects to the upstream `ConnectableObservable` if the number of subscribed subscriber reaches 1 and disconnect after the specified timeout if all subscribers have unsubscribed.
public final Observable<T>	Returns: the new Observable instance refCount(int the number of subscribers required to connect to the upstream subscriberCount, long the time to wait before disconnecting after all subscribers unsubscribed timeout, TimeUnit the time unit of the timeout unit) Connects to the upstream `ConnectableObservable` if the number of subscribed subscriber reaches the specified count and disconnect after the specified timeout if all subscribers have unsubscribed.
public final Observable<T>	Returns: the new Observable instance refCount(int the number of subscribers required to connect to the upstream subscriberCount, long the time to wait before disconnecting after all subscribers unsubscribed timeout, TimeUnit the time unit of the timeout unit, Scheduler the target scheduler to wait on before disconnecting scheduler) Connects to the upstream `ConnectableObservable` if the number of subscribed subscriber reaches the specified count and disconnect after the specified timeout if all subscribers have unsubscribed.

Inherited from io.reactivex.Observable:: all amb ambArray ambWith any as blockingFirst blockingFirst blockingForEach blockingIterable blockingIterable blockingLast blockingLast blockingLatest blockingMostRecent blockingNext blockingSingle blockingSingle blockingSubscribe blockingSubscribe blockingSubscribe blockingSubscribe blockingSubscribe buffer buffer buffer buffer buffer buffer buffer buffer buffer buffer buffer buffer buffer buffer buffer buffer buffer buffer buffer bufferSize cache cacheWithInitialCapacity cast collect collectInto combineLatest combineLatest combineLatest combineLatest combineLatest combineLatest combineLatest combineLatest combineLatest combineLatest combineLatest combineLatest combineLatest combineLatestDelayError combineLatestDelayError combineLatestDelayError combineLatestDelayError combineLatestDelayError compose concat concat concat concat concat concat concatArray concatArrayDelayError concatArrayEager concatArrayEager concatArrayEagerDelayError concatArrayEagerDelayError concatDelayError concatDelayError concatDelayError concatEager concatEager concatEager concatEager concatMap concatMap concatMapCompletable concatMapCompletable concatMapCompletableDelayError concatMapCompletableDelayError concatMapCompletableDelayError concatMapDelayError concatMapDelayError concatMapEager concatMapEager concatMapEagerDelayError concatMapEagerDelayError concatMapIterable concatMapIterable concatMapMaybe concatMapMaybe concatMapMaybeDelayError concatMapMaybeDelayError concatMapMaybeDelayError concatMapSingle concatMapSingle concatMapSingleDelayError concatMapSingleDelayError concatMapSingleDelayError concatWith concatWith concatWith concatWith contains count create debounce debounce debounce defaultIfEmpty defer delay delay delay delay delay delay delaySubscription delaySubscription delaySubscription dematerialize dematerialize distinct distinct distinct distinctUntilChanged distinctUntilChanged distinctUntilChanged doAfterNext doAfterTerminate doFinally doOnComplete doOnDispose doOnEach doOnEach doOnError doOnLifecycle doOnNext doOnSubscribe doOnTerminate elementAt elementAt elementAtOrError empty error error filter first firstElement firstOrError flatMap flatMap flatMap flatMap flatMap flatMap flatMap flatMap flatMap flatMap flatMap flatMap flatMapCompletable flatMapCompletable flatMapIterable flatMapIterable flatMapMaybe flatMapMaybe flatMapSingle flatMapSingle forEach forEachWhile forEachWhile forEachWhile fromArray fromCallable fromFuture fromFuture fromFuture fromFuture fromIterable fromPublisher generate generate generate generate generate groupBy groupBy groupBy groupBy groupBy groupJoin hide ignoreElements interval interval interval interval intervalRange intervalRange isEmpty join just just just just just just just just just just last lastElement lastOrError lift map materialize merge merge merge merge merge merge merge merge mergeArray mergeArray mergeArrayDelayError mergeArrayDelayError mergeDelayError mergeDelayError mergeDelayError mergeDelayError mergeDelayError mergeDelayError mergeDelayError mergeDelayError mergeWith mergeWith mergeWith mergeWith never observeOn observeOn observeOn ofType onErrorResumeNext onErrorResumeNext onErrorReturn onErrorReturnItem onExceptionResumeNext onTerminateDetach publish publish range rangeLong reduce reduce reduceWith repeat repeat repeatUntil repeatWhen replay replay replay replay replay replay replay replay replay replay replay replay replay replay replay replay retry retry retry retry retry retryUntil retryWhen safeSubscribe sample sample sample sample sample sample scan scan scanWith sequenceEqual sequenceEqual sequenceEqual sequenceEqual serialize share single singleElement singleOrError skip skip skip skipLast skipLast skipLast skipLast skipLast skipLast skipUntil skipWhile sorted sorted startWith startWith startWith startWithArray subscribe subscribe subscribe subscribe subscribe subscribe subscribeActual subscribeOn subscribeWith switchIfEmpty switchMap switchMap switchMapCompletable switchMapCompletableDelayError switchMapDelayError switchMapDelayError switchMapMaybe switchMapMaybeDelayError switchMapSingle switchMapSingleDelayError switchOnNext switchOnNext switchOnNextDelayError switchOnNextDelayError take take take takeLast takeLast takeLast takeLast takeLast takeLast takeLast takeLast takeLast takeUntil takeUntil takeWhile test test throttleFirst throttleFirst throttleLast throttleLast throttleLatest throttleLatest throttleLatest throttleLatest throttleWithTimeout throttleWithTimeout timeInterval timeInterval timeInterval timeInterval timeout timeout timeout timeout timeout timeout timeout timeout timer timer timestamp timestamp timestamp timestamp to toFlowable toFuture toList toList toList toMap toMap toMap toMultimap toMultimap toMultimap toMultimap toSortedList toSortedList toSortedList toSortedList unsafeCreate unsubscribeOn using using window window window window window window window window window window window window window window window window window window window withLatestFrom withLatestFrom withLatestFrom withLatestFrom withLatestFrom withLatestFrom wrap zip zip zip zip zip zip zip zip zip zip zip zip zipArray zipIterable zipWith zipWith zipWith zipWith

Constructor Detail

ConnectableObservable	back to summary
public ConnectableObservable()

Method Detail

autoConnect back to summary

autoConnect	back to summary
public Observable<T> autoConnect() Returns an Observable that automatically connects (at most once) to this ConnectableObservable when the first Observer subscribes. The connection happens after the first subscription and happens at most once during the lifetime of the returned Observable. If this ConnectableObservable terminates, the connection is never renewed, no matter how Observers come and go. Use `refCount()` to renew a connection or dispose an active connection when all `Observer`s have disposed their `Disposable`s. This overload does not allow disconnecting the connection established via `connect(Consumer)`. Use the `autoConnect(int, Consumer)` overload to gain access to the `Disposable` representing the only connection. Returns:Observable<T> an Observable that automatically connects to this ConnectableObservable when the first Observer subscribes Annotations @NonNull

public Observable<T> autoConnect()

Returns an Observable that automatically connects (at most once) to this ConnectableObservable when the first Observer subscribes.

The connection happens after the first subscription and happens at most once during the lifetime of the returned Observable. If this ConnectableObservable terminates, the connection is never renewed, no matter how Observers come and go. Use refCount() to renew a connection or dispose an active connection when all Observers have disposed their Disposables.

This overload does not allow disconnecting the connection established via connect(Consumer). Use the autoConnect(int, Consumer) overload to gain access to the Disposable representing the only connection.

Returns:Observable<T>

an Observable that automatically connects to this ConnectableObservable when the first Observer subscribes

Annotations

@NonNull

autoConnect back to summary

autoConnect	back to summary
public Observable<T> autoConnect(int numberOfSubscribers) Returns an Observable that automatically connects (at most once) to this ConnectableObservable when the specified number of Observers subscribe to it. The connection happens after the given number of subscriptions and happens at most once during the lifetime of the returned Observable. If this ConnectableObservable terminates, the connection is never renewed, no matter how Observers come and go. Use `refCount()` to renew a connection or dispose an active connection when all `Observer`s have disposed their `Disposable`s. This overload does not allow disconnecting the connection established via `connect(Consumer)`. Use the `autoConnect(int, Consumer)` overload to gain access to the `Disposable` representing the only connection. Parameters numberOfSubscribers:int the number of subscribers to await before calling connect on the ConnectableObservable. A non-positive value indicates an immediate connection. Returns:Observable<T> an Observable that automatically connects to this ConnectableObservable when the specified number of Subscribers subscribe to it Annotations @NonNull

public Observable<T> autoConnect(int numberOfSubscribers)

Returns an Observable that automatically connects (at most once) to this ConnectableObservable when the specified number of Observers subscribe to it.

The connection happens after the given number of subscriptions and happens at most once during the lifetime of the returned Observable. If this ConnectableObservable terminates, the connection is never renewed, no matter how Observers come and go. Use refCount() to renew a connection or dispose an active connection when all Observers have disposed their Disposables.

Parameters

numberOfSubscribers:int: the number of subscribers to await before calling connect on the ConnectableObservable. A non-positive value indicates an immediate connection.

Returns:Observable<T>

an Observable that automatically connects to this ConnectableObservable when the specified number of Subscribers subscribe to it

Annotations

@NonNull

autoConnect back to summary

autoConnect	back to summary
public Observable<T> autoConnect(int numberOfSubscribers, Consumer<? super Disposable> connection) Returns an Observable that automatically connects (at most once) to this ConnectableObservable when the specified number of Subscribers subscribe to it and calls the specified callback with the Subscription associated with the established connection. The connection happens after the given number of subscriptions and happens at most once during the lifetime of the returned Observable. If this ConnectableObservable terminates, the connection is never renewed, no matter how Observers come and go. Use `refCount()` to renew a connection or dispose an active connection when all `Observer`s have disposed their `Disposable`s. Parameters numberOfSubscribers:int the number of subscribers to await before calling connect on the ConnectableObservable. A non-positive value indicates an immediate connection. connection:Consumer<? super Disposable> the callback Consumer that will receive the Subscription representing the established connection Returns:Observable<T> an Observable that automatically connects to this ConnectableObservable when the specified number of Subscribers subscribe to it and calls the specified callback with the Subscription associated with the established connection Annotations @NonNull

public Observable<T> autoConnect(int numberOfSubscribers, Consumer<? super Disposable> connection)

Returns an Observable that automatically connects (at most once) to this ConnectableObservable when the specified number of Subscribers subscribe to it and calls the specified callback with the Subscription associated with the established connection.

Parameters

numberOfSubscribers:int: the number of subscribers to await before calling connect on the ConnectableObservable. A non-positive value indicates an immediate connection.
connection:Consumer<? super Disposable>: the callback Consumer that will receive the Subscription representing the established connection

Returns:Observable<T>

an Observable that automatically connects to this ConnectableObservable when the specified number of Subscribers subscribe to it and calls the specified callback with the Subscription associated with the established connection

Annotations

@NonNull

connect back to summary

connect	back to summary
public abstract void connect(Consumer<? super Disposable> connection) Instructs the `ConnectableObservable` to begin emitting the items from its underlying `Observable` to its `Observer`s. Parameters connection:Consumer<? super Disposable> the action that receives the connection subscription before the subscription to source happens allowing the caller to synchronously disconnect a synchronous source See Also ReactiveX documentation: Connect

public abstract void connect(Consumer<? super Disposable> connection)

Instructs the ConnectableObservable to begin emitting the items from its underlying Observable to its Observers.

Parameters

connection:Consumer<? super Disposable>: the action that receives the connection subscription before the subscription to source happens allowing the caller to synchronously disconnect a synchronous source

See Also

ReactiveX documentation: Connect

connect back to summary

connect	back to summary
public final Disposable connect() Instructs the `ConnectableObservable` to begin emitting the items from its underlying `Observable` to its `Observer`s. To disconnect from a synchronous source, use the `connect(Consumer)` method. Returns:Disposable the subscription representing the connection See Also ReactiveX documentation: Connect

public final Disposable connect()

Instructs the ConnectableObservable to begin emitting the items from its underlying Observable to its Observers.

To disconnect from a synchronous source, use the connect(Consumer) method.

Returns:Disposable: the subscription representing the connection
See Also: ReactiveX documentation: Connect

onRefCount	back to summary
private ConnectableObservable<T> onRefCount() Apply a workaround for a race condition with the regular publish().refCount() so that racing observers and refCount won't hang. Returns:ConnectableObservable<T> the ConnectableObservable to work with Annotations @SuppressWarnings:unchecked Since 2.2.10

onRefCount

back to summary

private ConnectableObservable<T> onRefCount()

Apply a workaround for a race condition with the regular publish().refCount() so that racing observers and refCount won't hang.

Returns:ConnectableObservable<T>

the ConnectableObservable to work with

Annotations

@SuppressWarnings:unchecked

Since

2.2.10

refCount back to summary

refCount	back to summary
public Observable<T> refCount() Returns an `Observable` that stays connected to this `ConnectableObservable` as long as there is at least one subscription to this `ConnectableObservable`. Scheduler: This `refCount` overload does not operate on any particular `Scheduler`. Returns:Observable<T> an `Observable` Annotations @NonNull @CheckReturnValue @SchedulerSupport:none See Also ReactiveX documentation: RefCount, `refCount(int)`, `refCount(long, TimeUnit)`, `refCount(int, long, TimeUnit)`

public Observable<T> refCount()

Returns an Observable that stays connected to this ConnectableObservable as long as there is at least one subscription to this ConnectableObservable.

Scheduler:: This refCount overload does not operate on any particular Scheduler.

Returns:Observable<T>

an Observable

Annotations

@NonNull
@CheckReturnValue
@SchedulerSupport:none

refCount back to summary

refCount	back to summary
public final Observable<T> refCount(int subscriberCount) Connects to the upstream `ConnectableObservable` if the number of subscribed subscriber reaches the specified count and disconnect if all subscribers have unsubscribed. Scheduler: This `refCount` overload does not operate on any particular `Scheduler`. History: 2.1.14 - experimental Parameters subscriberCount:int the number of subscribers required to connect to the upstream Returns:Observable<T> the new Observable instance Annotations @CheckReturnValue @SchedulerSupport:none Since 2.2

public final Observable<T> refCount(int subscriberCount)

Connects to the upstream ConnectableObservable if the number of subscribed subscriber reaches the specified count and disconnect if all subscribers have unsubscribed.

Scheduler:: This refCount overload does not operate on any particular Scheduler.

History: 2.1.14 - experimental

Parameters

subscriberCount:int: the number of subscribers required to connect to the upstream

Returns:Observable<T>

the new Observable instance

Annotations

@CheckReturnValue
@SchedulerSupport:none

Since

2.2

refCount back to summary

refCount	back to summary
public final Observable<T> refCount(long timeout, TimeUnit unit) Connects to the upstream `ConnectableObservable` if the number of subscribed subscriber reaches 1 and disconnect after the specified timeout if all subscribers have unsubscribed. Scheduler: This `refCount` overload operates on the `computation` `Scheduler`. History: 2.1.14 - experimental Parameters timeout:long the time to wait before disconnecting after all subscribers unsubscribed unit:TimeUnit the time unit of the timeout Returns:Observable<T> the new Observable instance Annotations @CheckReturnValue @SchedulerSupport:io.reactivex:computation Since 2.2 See Also `refCount(long, TimeUnit, Scheduler)`

public final Observable<T> refCount(long timeout, TimeUnit unit)

Connects to the upstream ConnectableObservable if the number of subscribed subscriber reaches 1 and disconnect after the specified timeout if all subscribers have unsubscribed.

Scheduler:: This refCount overload operates on the computation Scheduler.

History: 2.1.14 - experimental

Parameters

timeout:long: the time to wait before disconnecting after all subscribers unsubscribed
unit:TimeUnit: the time unit of the timeout

Returns:Observable<T>

the new Observable instance

Annotations

@CheckReturnValue
@SchedulerSupport:io.reactivex:computation

Since

2.2

See Also

refCount(long, TimeUnit, Scheduler)

refCount back to summary

refCount	back to summary
public final Observable<T> refCount(long timeout, TimeUnit unit, Scheduler scheduler) Connects to the upstream `ConnectableObservable` if the number of subscribed subscriber reaches 1 and disconnect after the specified timeout if all subscribers have unsubscribed. Scheduler: This `refCount` overload operates on the specified `Scheduler`. History: 2.1.14 - experimental Parameters timeout:long the time to wait before disconnecting after all subscribers unsubscribed unit:TimeUnit the time unit of the timeout scheduler:Scheduler the target scheduler to wait on before disconnecting Returns:Observable<T> the new Observable instance Annotations @CheckReturnValue @SchedulerSupport:custom Since 2.2

public final Observable<T> refCount(long timeout, TimeUnit unit, Scheduler scheduler)

Connects to the upstream ConnectableObservable if the number of subscribed subscriber reaches 1 and disconnect after the specified timeout if all subscribers have unsubscribed.

Scheduler:: This refCount overload operates on the specified Scheduler.

History: 2.1.14 - experimental

Parameters

timeout:long: the time to wait before disconnecting after all subscribers unsubscribed
unit:TimeUnit: the time unit of the timeout
scheduler:Scheduler: the target scheduler to wait on before disconnecting

Returns:Observable<T>

the new Observable instance

Annotations

@CheckReturnValue
@SchedulerSupport:custom

Since

2.2

refCount back to summary

refCount	back to summary
public final Observable<T> refCount(int subscriberCount, long timeout, TimeUnit unit) Connects to the upstream `ConnectableObservable` if the number of subscribed subscriber reaches the specified count and disconnect after the specified timeout if all subscribers have unsubscribed. Scheduler: This `refCount` overload operates on the `computation` `Scheduler`. History: 2.1.14 - experimental Parameters subscriberCount:int the number of subscribers required to connect to the upstream timeout:long the time to wait before disconnecting after all subscribers unsubscribed unit:TimeUnit the time unit of the timeout Returns:Observable<T> the new Observable instance Annotations @CheckReturnValue @SchedulerSupport:io.reactivex:computation Since 2.2 See Also `refCount(int, long, TimeUnit, Scheduler)`

public final Observable<T> refCount(int subscriberCount, long timeout, TimeUnit unit)

Connects to the upstream ConnectableObservable if the number of subscribed subscriber reaches the specified count and disconnect after the specified timeout if all subscribers have unsubscribed.

Scheduler:: This refCount overload operates on the computation Scheduler.

History: 2.1.14 - experimental

Parameters

subscriberCount:int: the number of subscribers required to connect to the upstream
timeout:long: the time to wait before disconnecting after all subscribers unsubscribed
unit:TimeUnit: the time unit of the timeout

Returns:Observable<T>

the new Observable instance

Annotations

@CheckReturnValue
@SchedulerSupport:io.reactivex:computation

Since

2.2

refCount back to summary

refCount	back to summary
public final Observable<T> refCount(int subscriberCount, long timeout, TimeUnit unit, Scheduler scheduler) Connects to the upstream `ConnectableObservable` if the number of subscribed subscriber reaches the specified count and disconnect after the specified timeout if all subscribers have unsubscribed. Scheduler: This `refCount` overload operates on the specified `Scheduler`. History: 2.1.14 - experimental Parameters subscriberCount:int the number of subscribers required to connect to the upstream timeout:long the time to wait before disconnecting after all subscribers unsubscribed unit:TimeUnit the time unit of the timeout scheduler:Scheduler the target scheduler to wait on before disconnecting Returns:Observable<T> the new Observable instance Annotations @CheckReturnValue @SchedulerSupport:custom Since 2.2

public final Observable<T> refCount(int subscriberCount, long timeout, TimeUnit unit, Scheduler scheduler)

Connects to the upstream ConnectableObservable if the number of subscribed subscriber reaches the specified count and disconnect after the specified timeout if all subscribers have unsubscribed.

Scheduler:: This refCount overload operates on the specified Scheduler.

History: 2.1.14 - experimental

Parameters

subscriberCount:int: the number of subscribers required to connect to the upstream
timeout:long: the time to wait before disconnecting after all subscribers unsubscribed
unit:TimeUnit: the time unit of the timeout
scheduler:Scheduler: the target scheduler to wait on before disconnecting

Returns:Observable<T>

the new Observable instance

Annotations

@CheckReturnValue
@SchedulerSupport:custom

Since

2.2

public abstract Class ConnectableObservable<T>

Constructor Summary

Method Summary

Constructor Detail

Method Detail