RxJava 3 3.1.8 · io.reactivex.rxjava3.observables.ConnectableObservable

Constructor Summary

Access	Constructor and Description
public	ConnectableObservable()

Method Summary

Modifier and Type	Method and Description
public @NonNull Observable<T>	Returns: a new `Observable` instance 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 @NonNull Observable<T>	Returns: a new `Observable` instance that automatically connects to this `ConnectableObservable` when the specified number of `Observer`s 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. numberOfObservers) Returns an `Observable` that automatically connects (at most once) to this `ConnectableObservable` when the specified number of `Observer`s subscribe to it.
public @NonNull Observable<T>	Returns: a new `Observable` instance that automatically connects to this `ConnectableObservable` when the specified number of `Observer`s subscribe to it and calls the specified callback with the `Disposable` 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. numberOfObservers, @NonNull Consumer<? super Disposable> the callback `Consumer` that will receive the `Disposable` representing the established connection connection) Returns an `Observable` that automatically connects (at most once) to this `ConnectableObservable` when the specified number of `Observer`s subscribe to it and calls the specified callback with the `Disposable` associated with the established connection.
public abstract void	connect(@NonNull 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 @NonNull Disposable	Returns: the `Disposable` representing the connection connect() Instructs the `ConnectableObservable` to begin emitting the items from its underlying `Observable` to its `Observer`s.
public @NonNull Observable<T>	Returns: a new `Observable` instance refCount() Returns an `Observable` that stays connected to this `ConnectableObservable` as long as there is at least one subscription to this `ConnectableObservable`.
public final @NonNull Observable<T>	Returns: the new `Observable` instance refCount(int the number of `Observer`s required to connect to the upstream observerCount) Connects to the upstream `ConnectableObservable` if the number of subscribed observers reaches the specified count and disconnect if all `Observer`s have unsubscribed.
public final @NonNull Observable<T>	Returns: the new `Observable` instance refCount(long the time to wait before disconnecting after all `Observer`s unsubscribed timeout, @NonNull TimeUnit the time unit of the timeout unit) Connects to the upstream `ConnectableObservable` if the number of subscribed observers reaches 1 and disconnect after the specified timeout if all `Observer`s have unsubscribed.
public final @NonNull Observable<T>	Returns: the new `Observable` instance refCount(long the time to wait before disconnecting after all `Observer`s unsubscribed timeout, @NonNull TimeUnit the time unit of the timeout unit, @NonNull Scheduler the target scheduler to wait on before disconnecting scheduler) Connects to the upstream `ConnectableObservable` if the number of subscribed observers reaches 1 and disconnect after the specified timeout if all `Observer`s have unsubscribed.
public final @NonNull Observable<T>	Returns: the new `Observable` instance refCount(int the number of `Observer`s required to connect to the upstream observerCount, long the time to wait before disconnecting after all `Observer`s unsubscribed timeout, @NonNull TimeUnit the time unit of the timeout unit) Connects to the upstream `ConnectableObservable` if the number of subscribed observers reaches the specified count and disconnect after the specified timeout if all `Observer`s have unsubscribed.
public final @NonNull Observable<T>	Returns: the new `Observable` instance refCount(int the number of `Observer`s required to connect to the upstream observerCount, long the time to wait before disconnecting after all `Observer`s unsubscribed timeout, @NonNull TimeUnit the time unit of the timeout unit, @NonNull Scheduler the target scheduler to wait on before disconnecting scheduler) Connects to the upstream `ConnectableObservable` if the number of subscribed observers reaches the specified count and disconnect after the specified timeout if all `Observer`s have unsubscribed.
public abstract void	reset() Resets this `ConnectableObservable` into its fresh state if it has terminated or has been disposed.

Inherited from io.reactivex.rxjava3.core.Observable:: all amb ambArray ambWith any blockingFirst blockingFirst blockingForEach blockingForEach blockingIterable blockingIterable blockingLast blockingLast blockingLatest blockingMostRecent blockingNext blockingSingle blockingSingle blockingStream blockingStream blockingSubscribe blockingSubscribe blockingSubscribe blockingSubscribe blockingSubscribe buffer buffer buffer buffer buffer buffer buffer buffer buffer buffer buffer buffer buffer buffer buffer buffer buffer bufferSize cache cacheWithInitialCapacity cast collect collect collectInto combineLatest combineLatest combineLatest combineLatest combineLatest combineLatest combineLatest combineLatest combineLatest combineLatest combineLatestArray combineLatestArray combineLatestArrayDelayError combineLatestArrayDelayError combineLatestDelayError combineLatestDelayError compose concat concat concat concat concat concat concatArray concatArrayDelayError concatArrayEager concatArrayEager concatArrayEagerDelayError concatArrayEagerDelayError concatDelayError concatDelayError concatDelayError concatEager concatEager concatEager concatEager concatEagerDelayError concatEagerDelayError concatEagerDelayError concatEagerDelayError concatMap concatMap concatMap concatMapCompletable concatMapCompletable concatMapCompletableDelayError concatMapCompletableDelayError concatMapCompletableDelayError concatMapDelayError concatMapDelayError concatMapDelayError concatMapEager concatMapEager concatMapEagerDelayError concatMapEagerDelayError concatMapIterable concatMapMaybe concatMapMaybe concatMapMaybeDelayError concatMapMaybeDelayError concatMapMaybeDelayError concatMapSingle concatMapSingle concatMapSingleDelayError concatMapSingleDelayError concatMapSingleDelayError concatMapStream concatWith concatWith concatWith concatWith contains count create debounce debounce debounce debounce defaultIfEmpty defer delay delay delay delay delay delay delaySubscription delaySubscription delaySubscription 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 firstOrErrorStage firstStage flatMap flatMap flatMap flatMap flatMap flatMap flatMap flatMap flatMap flatMap flatMap flatMap flatMapCompletable flatMapCompletable flatMapIterable flatMapIterable flatMapMaybe flatMapMaybe flatMapSingle flatMapSingle flatMapStream forEach forEachWhile forEachWhile forEachWhile fromAction fromArray fromCallable fromCompletable fromCompletionStage fromFuture fromFuture fromIterable fromMaybe fromOptional fromPublisher fromRunnable fromSingle fromStream fromSupplier 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 lastOrErrorStage lastStage lift map mapOptional 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 onErrorComplete onErrorComplete onErrorResumeNext onErrorResumeWith onErrorReturn onErrorReturnItem 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 replay replay retry retry retry retry retry retryUntil retryWhen safeSubscribe sample sample sample sample sample sample sample scan scan scanWith sequenceEqual sequenceEqual sequenceEqual sequenceEqual serialize share single singleElement singleOrError singleOrErrorStage singleStage skip skip skip skipLast skipLast skipLast skipLast skipLast skipLast skipUntil skipWhile sorted sorted startWith startWith startWith startWith startWithArray startWithItem startWithIterable 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 throttleFirst throttleLast throttleLast throttleLast throttleLatest throttleLatest throttleLatest throttleLatest throttleLatest throttleWithTimeout 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 withLatestFrom withLatestFrom withLatestFrom withLatestFrom withLatestFrom withLatestFrom wrap zip zip zip zip zip zip zip zip zip zip zip zip zipArray zipWith zipWith zipWith zipWith

Constructor Detail

ConnectableObservable	back to summary
public ConnectableObservable()

Method Detail

autoConnect back to summary

autoConnect	back to summary
public @NonNull 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 `Observer`s 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. Scheduler: `autoConnect` overload does not operate on any particular `Scheduler`. Returns:@NonNull Observable<T> a new `Observable` instance that automatically connects to this `ConnectableObservable` when the first `Observer` subscribes Annotations @NonNull @CheckReturnValue @SchedulerSupport:none

public @NonNull 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.

Scheduler:: autoConnect overload does not operate on any particular Scheduler.

Returns:@NonNull Observable<T>

a new Observable instance that automatically connects to this ConnectableObservable when the first Observer subscribes

Annotations

@NonNull
@CheckReturnValue
@SchedulerSupport:none

autoConnect back to summary

autoConnect	back to summary
public @NonNull Observable<T> autoConnect(int numberOfObservers) Returns an `Observable` that automatically connects (at most once) to this `ConnectableObservable` when the specified number of `Observer`s 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 `Observer`s 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. Scheduler: `autoConnect` overload does not operate on any particular `Scheduler`. Parameters numberOfObservers:int the number of subscribers to await before calling connect on the `ConnectableObservable`. A non-positive value indicates an immediate connection. Returns:@NonNull Observable<T> a new `Observable` instance that automatically connects to this `ConnectableObservable` when the specified number of `Observer`s subscribe to it Annotations @NonNull @CheckReturnValue @SchedulerSupport:none

public @NonNull Observable<T> autoConnect(int numberOfObservers)

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.

Scheduler:: autoConnect overload does not operate on any particular Scheduler.

Parameters

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

Returns:@NonNull Observable<T>

a new Observable instance that automatically connects to this ConnectableObservable when the specified number of Observers subscribe to it

Annotations

@NonNull
@CheckReturnValue
@SchedulerSupport:none

autoConnect back to summary

autoConnect	back to summary
public @NonNull Observable<T> autoConnect(int numberOfObservers, @NonNull Consumer<? super Disposable> connection) Returns an `Observable` that automatically connects (at most once) to this `ConnectableObservable` when the specified number of `Observer`s subscribe to it and calls the specified callback with the `Disposable` 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 `Observer`s come and go. Use `refCount()` to renew a connection or dispose an active connection when all `Observer`s have disposed their `Disposable`s. Scheduler: `autoConnect` overload does not operate on any particular `Scheduler`. Parameters numberOfObservers:int the number of subscribers to await before calling connect on the `ConnectableObservable`. A non-positive value indicates an immediate connection. connection:@NonNull Consumer<? super Disposable> the callback `Consumer` that will receive the `Disposable` representing the established connection Returns:@NonNull Observable<T> a new `Observable` instance that automatically connects to this `ConnectableObservable` when the specified number of `Observer`s subscribe to it and calls the specified callback with the `Disposable` associated with the established connection Annotations @NonNull @CheckReturnValue @SchedulerSupport:none Exceptions NullPointerException: if `connection` is `null`

public @NonNull Observable<T> autoConnect(int numberOfObservers, @NonNull Consumer<? super Disposable> connection)

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

Scheduler:: autoConnect overload does not operate on any particular Scheduler.

Parameters

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

Returns:@NonNull Observable<T>

a new Observable instance that automatically connects to this ConnectableObservable when the specified number of Observers subscribe to it and calls the specified callback with the Disposable associated with the established connection

Annotations

@NonNull
@CheckReturnValue
@SchedulerSupport:none

Exceptions

NullPointerException:: if connection is null

connect back to summary

connect	back to summary
public abstract void connect(@NonNull Consumer<? super Disposable> connection) Instructs the `ConnectableObservable` to begin emitting the items from its underlying `Observable` to its `Observer`s. Scheduler: The behavior is determined by the implementor of this abstract class. Parameters connection:@NonNull 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 Annotations @SchedulerSupport:none Exceptions NullPointerException: if `connection` is `null` See Also ReactiveX documentation: Connect

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

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

Scheduler:: The behavior is determined by the implementor of this abstract class.

Parameters

connection:@NonNull 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

Annotations

@SchedulerSupport:none

Exceptions

NullPointerException:: if connection is null

See Also

ReactiveX documentation: Connect

connect back to summary

connect	back to summary
public final @NonNull 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. Scheduler: The behavior is determined by the implementor of this abstract class. Returns:@NonNull Disposable the `Disposable` representing the connection Annotations @NonNull @SchedulerSupport:none See Also ReactiveX documentation: Connect

public final @NonNull 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.

Scheduler:: The behavior is determined by the implementor of this abstract class.

Returns:@NonNull Disposable

the Disposable representing the connection

Annotations

@NonNull
@SchedulerSupport:none

See Also

ReactiveX documentation: Connect

refCount back to summary

refCount	back to summary
public @NonNull 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:@NonNull Observable<T> a new `Observable` instance Annotations @NonNull @CheckReturnValue @SchedulerSupport:none See Also ReactiveX documentation: RefCount, `refCount(int)`, `refCount(long, TimeUnit)`, `refCount(int, long, TimeUnit)`

public @NonNull 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:@NonNull Observable<T>

a new Observable instance

Annotations

@NonNull
@CheckReturnValue
@SchedulerSupport:none

refCount back to summary

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

public final @NonNull Observable<T> refCount(int observerCount)

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

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

History: 2.1.14 - experimental

Parameters

observerCount:int: the number of Observers required to connect to the upstream

Returns:@NonNull Observable<T>

the new Observable instance

Annotations

@CheckReturnValue
@SchedulerSupport:none
@NonNull

Exceptions

IllegalArgumentException:: if observerCount is non-positive

Since

2.2

refCount back to summary

refCount	back to summary
public final @NonNull Observable<T> refCount(long timeout, @NonNull TimeUnit unit) Connects to the upstream `ConnectableObservable` if the number of subscribed observers reaches 1 and disconnect after the specified timeout if all `Observer`s 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 `Observer`s unsubscribed unit:@NonNull TimeUnit the time unit of the timeout Returns:@NonNull Observable<T> the new `Observable` instance Annotations @CheckReturnValue @SchedulerSupport:io.reactivex:computation @NonNull Exceptions NullPointerException: if `unit` is `null` Since 2.2 See Also `refCount(long, TimeUnit, Scheduler)`

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

Connects to the upstream ConnectableObservable if the number of subscribed observers reaches 1 and disconnect after the specified timeout if all Observers 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 Observers unsubscribed
unit:@NonNull TimeUnit: the time unit of the timeout

Returns:@NonNull Observable<T>

the new Observable instance

Annotations

@CheckReturnValue
@SchedulerSupport:io.reactivex:computation
@NonNull

Exceptions

NullPointerException:: if unit is null

Since

2.2

See Also

refCount(long, TimeUnit, Scheduler)

refCount back to summary

refCount	back to summary
public final @NonNull Observable<T> refCount(long timeout, @NonNull TimeUnit unit, @NonNull Scheduler scheduler) Connects to the upstream `ConnectableObservable` if the number of subscribed observers reaches 1 and disconnect after the specified timeout if all `Observer`s 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 `Observer`s unsubscribed unit:@NonNull TimeUnit the time unit of the timeout scheduler:@NonNull Scheduler the target scheduler to wait on before disconnecting Returns:@NonNull Observable<T> the new `Observable` instance Annotations @CheckReturnValue @SchedulerSupport:custom @NonNull Exceptions NullPointerException: if `unit` or `scheduler` is `null` Since 2.2

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

Connects to the upstream ConnectableObservable if the number of subscribed observers reaches 1 and disconnect after the specified timeout if all Observers 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 Observers unsubscribed
unit:@NonNull TimeUnit: the time unit of the timeout
scheduler:@NonNull Scheduler: the target scheduler to wait on before disconnecting

Returns:@NonNull Observable<T>

the new Observable instance

Annotations

@CheckReturnValue
@SchedulerSupport:custom
@NonNull

Exceptions

NullPointerException:: if unit or scheduler is null

Since

2.2

refCount back to summary

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

public final @NonNull Observable<T> refCount(int observerCount, long timeout, @NonNull TimeUnit unit)

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

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

History: 2.1.14 - experimental

Parameters

observerCount:int: the number of Observers required to connect to the upstream
timeout:long: the time to wait before disconnecting after all Observers unsubscribed
unit:@NonNull TimeUnit: the time unit of the timeout

Returns:@NonNull Observable<T>

the new Observable instance

Annotations

@CheckReturnValue
@SchedulerSupport:io.reactivex:computation
@NonNull

Exceptions

NullPointerException:: if unit or scheduler is null
IllegalArgumentException:: if observerCount is non-positive

Since

2.2

refCount back to summary

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

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

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

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

History: 2.1.14 - experimental

Parameters

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

Returns:@NonNull Observable<T>

the new Observable instance

Annotations

@CheckReturnValue
@SchedulerSupport:custom
@NonNull

Exceptions

NullPointerException:: if unit or scheduler is null
IllegalArgumentException:: if observerCount is non-positive

Since

2.2

reset back to summary

reset	back to summary
public abstract void reset() Resets this `ConnectableObservable` into its fresh state if it has terminated or has been disposed. Calling this method on a fresh or active `ConnectableObservable` has no effect. Scheduler: The behavior is determined by the implementor of this abstract class. Annotations @SchedulerSupport:none Since 3.0.0

public abstract void reset()

Resets this ConnectableObservable into its fresh state if it has terminated or has been disposed.

Calling this method on a fresh or active ConnectableObservable has no effect.

Scheduler:: The behavior is determined by the implementor of this abstract class.

Annotations

@SchedulerSupport:none

Since

3.0.0

public abstract Class ConnectableObservable<T>

Constructor Summary

Method Summary

Constructor Detail

Method Detail