Package rx

Interface Subscription

All Known Implementing Classes:
ActionSubscriber, AsyncCompletableSubscriber, AsyncCompletableSubscriber.Unsubscribed, AsyncOnSubscribe.AsyncOuterManager, BlockingOperatorLatest.LatestObserverIterator, BlockingOperatorMostRecent.MostRecentObserver, BlockingOperatorNext.NextObserver, BlockingOperatorToIterator.SubscriberIterator, BooleanSubscription, CachedObservable.ReplayProducer, CachedThreadScheduler.EventLoopWorker, CachedThreadScheduler.ThreadWorker, CompletableOnSubscribeConcat.CompletableConcatSubscriber, CompletableOnSubscribeMerge.CompletableMergeSubscriber, CompositeSubscription, DeferredScalarSubscriber, EventLoopsScheduler.EventLoopWorker, EventLoopsScheduler.PoolWorker, ExecutorScheduler.ExecutorSchedulerWorker, ImmediateScheduler.InnerImmediateScheduler, IndexedRingBuffer, MultipleAssignmentSubscription, NewThreadWorker, ObserverSubscriber, OnSubscribeAmb.AmbSubscriber, OnSubscribeCollect.CollectSubscriber, OnSubscribeCombineLatest.CombinerSubscriber, OnSubscribeCombineLatest.LatestCoordinator, OnSubscribeConcatMap.ConcatMapInnerSubscriber, OnSubscribeConcatMap.ConcatMapSubscriber, OnSubscribeDetach.DetachProducer, OnSubscribeDetach.DetachSubscriber, OnSubscribeFilter.FilterSubscriber, OnSubscribeFlattenIterable.FlattenIterableSubscriber, OnSubscribeFromAsync.BaseAsyncEmitter, OnSubscribeFromAsync.BufferAsyncEmitter, OnSubscribeFromAsync.CancellableSubscription, OnSubscribeFromAsync.DropAsyncEmitter, OnSubscribeFromAsync.ErrorAsyncEmitter, OnSubscribeFromAsync.LatestAsyncEmitter, OnSubscribeFromAsync.NoneAsyncEmitter, OnSubscribeFromAsync.NoOverflowBaseAsyncEmitter, OnSubscribeGroupJoin.ResultManager, OnSubscribeGroupJoin.ResultManager.LeftDurationObserver, OnSubscribeGroupJoin.ResultManager.LeftObserver, OnSubscribeGroupJoin.ResultManager.RightDurationObserver, OnSubscribeGroupJoin.ResultManager.RightObserver, OnSubscribeGroupJoin.WindowObservableFunc.WindowSubscriber, OnSubscribeJoin.ResultSink.LeftSubscriber, OnSubscribeJoin.ResultSink.LeftSubscriber.LeftDurationSubscriber, OnSubscribeJoin.ResultSink.RightSubscriber, OnSubscribeJoin.ResultSink.RightSubscriber.RightDurationSubscriber, OnSubscribeMap.MapSubscriber, OnSubscribeOnAssembly.OnAssemblySubscriber, OnSubscribeOnAssemblySingle.OnAssemblySingleSubscriber, OnSubscribePublishMulticast, OnSubscribePublishMulticast.ParentSubscriber, OnSubscribePublishMulticast.PublishProducer, OnSubscribeReduce.ReduceSubscriber, OnSubscribeReduceSeed.ReduceSeedSubscriber, OnSubscribeTakeLastOne.TakeLastOneSubscriber, OnSubscribeUsing.DisposeAction, OperatorBufferWithSingleObservable.BufferingSubscriber, OperatorBufferWithSize.BufferExact, OperatorBufferWithSize.BufferOverlap, OperatorBufferWithSize.BufferSkip, OperatorBufferWithStartEndObservable.BufferingSubscriber, OperatorBufferWithTime.ExactSubscriber, OperatorBufferWithTime.InexactSubscriber, OperatorCast.CastSubscriber, OperatorDoOnRequest.ParentSubscriber, OperatorEagerConcatMap.EagerInnerSubscriber, OperatorEagerConcatMap.EagerOuterSubscriber, OperatorGroupBy.GroupBySubscriber, OperatorGroupBy.State, OperatorMapNotification.MapNotificationSubscriber, OperatorMapPair.MapPairSubscriber, OperatorMaterialize.ParentSubscriber, OperatorMerge.InnerSubscriber, OperatorMerge.MergeSubscriber, OperatorObserveOn.ObserveOnSubscriber, OperatorOnBackpressureBuffer.BufferSubscriber, OperatorOnBackpressureLatest.LatestEmitter, OperatorOnBackpressureLatest.LatestSubscriber, OperatorPublish.InnerProducer, OperatorPublish.PublishSubscriber, OperatorReplay.InnerProducer, OperatorReplay.ReplaySubscriber, OperatorRetryWithPredicate.SourceSubscriber, OperatorSampleWithTime.SamplerSubscriber, OperatorSingle.ParentSubscriber, OperatorSwitch.InnerSubscriber, OperatorSwitch.SwitchSubscriber, OperatorSwitchIfEmpty.AlternateSubscriber, OperatorSwitchIfEmpty.ParentSubscriber, OperatorTakeLast.TakeLastSubscriber, OperatorTakeLastTimed.TakeLastTimedSubscriber, OperatorTakeTimed.TakeSubscriber, OperatorTakeUntilPredicate.ParentSubscriber, OperatorTimeoutBase.TimeoutSubscriber, OperatorWindowWithObservable.BoundarySubscriber, OperatorWindowWithObservable.SourceSubscriber, OperatorWindowWithObservableFactory.BoundarySubscriber, OperatorWindowWithObservableFactory.SourceSubscriber, OperatorWindowWithSize.WindowExact, OperatorWindowWithSize.WindowOverlap, OperatorWindowWithSize.WindowSkip, OperatorWindowWithStartEndObservable.SourceSubscriber, OperatorWindowWithTime.ExactSubscriber, OperatorWindowWithTime.InexactSubscriber, OperatorWithLatestFromMany.WithLatestMainSubscriber, OperatorWithLatestFromMany.WithLatestOtherSubscriber, OperatorZip.Zip.InnerSubscriber, OperatorZip.ZipSubscriber, RefCountSubscription, RefCountSubscription.InnerSubscription, ReplaySubject.ReplayProducer, RxRingBuffer, SafeCompletableSubscriber, SafeSubscriber, ScheduledAction, ScheduledAction.FutureCompleter, ScheduledAction.Remover, ScheduledAction.Remover2, Scheduler.Worker, SchedulerWhen, SchedulerWhen.DelayedAction, SchedulerWhen.ImmediateAction, SchedulerWhen.ScheduledAction, SerializedSubscriber, SerialSubscription, SingleDoAfterTerminate.SingleDoAfterTerminateSubscriber, SingleOnSubscribeMap.MapSubscriber, SingleSubscriber, Subscriber, SubscriptionList, Subscriptions.FutureSubscription, Subscriptions.Unsubscribed, SyncOnSubscribe.SubscriptionProducer, TestScheduler.InnerTestScheduler, TestSubscriber, TrampolineScheduler.InnerCurrentThreadScheduler, UnicastSubject.State
public interface Subscription
Subscription returns from Observable.subscribe(Subscriber) to allow unsubscribing.

See the utilities in Subscriptions and the implementations in the rx.subscriptions package.

This interface is the RxJava equivalent of IDisposable in Microsoft's Rx implementation.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isUnsubscribed()
    Indicates whether this Subscription is currently unsubscribed.
    void
    unsubscribe()
    Stops the receipt of notifications on the Subscriber that was registered when this Subscription was received.

  • Method Details

    • unsubscribe

      void unsubscribe()
      Stops the receipt of notifications on the Subscriber that was registered when this Subscription was received.

      This allows unregistering an Subscriber before it has finished receiving all events (i.e. before onCompleted is called).

    • isUnsubscribed

      boolean isUnsubscribed()
      Indicates whether this Subscription is currently unsubscribed.
      Returns:
      true if this Subscription is currently unsubscribed, false otherwise