Package rx.internal.operators

Class CachedObservable.ReplayProducer<T>

  • Type Parameters:
    T -
    All Implemented Interfaces:
    java.io.Serializable, Producer, Subscription
    Enclosing class:
    CachedObservable<T>
    static final class CachedObservable.ReplayProducer<T>
extends java.util.concurrent.atomic.AtomicLong
implements Producer, Subscription
    Keeps track of the current request amount and the replay position for a child Subscriber.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      (package private) Subscriber<? super T> child
      The actual child subscriber.
      (package private) java.lang.Object[] currentBuffer
      Contains the reference to the buffer segment in replay.
      (package private) int currentIndexInBuffer
      Contains the index into the currentBuffer where the next value is expected.
      (package private) boolean emitting
      Indicates there is a replay going on; guarded by this.
      (package private) int index
      Contains the absolute index up until the values have been replayed so far.
      (package private) boolean missed
      Indicates there were some state changes/replay attempts; guarded by this.
      private static long serialVersionUID  
      (package private) CachedObservable.CacheState<T> state
      The cache state object.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean isUnsubscribed()
      Indicates whether this Subscription is currently unsubscribed.
      long produced​(long n)
      Updates the request count to reflect values have been produced.
      void replay()
      Continue replaying available values if there are requests for them.
      void request​(long n)
      Request a certain maximum number of items from this Producer.
      void unsubscribe()
      Stops the receipt of notifications on the Subscriber that was registered when this Subscription was received.

      • Methods inherited from class java.util.concurrent.atomic.AtomicLong

        accumulateAndGet, addAndGet, compareAndExchange, compareAndExchangeAcquire, compareAndExchangeRelease, compareAndSet, decrementAndGet, doubleValue, floatValue, get, getAcquire, getAndAccumulate, getAndAdd, getAndDecrement, getAndIncrement, getAndSet, getAndUpdate, getOpaque, getPlain, incrementAndGet, intValue, lazySet, longValue, set, setOpaque, setPlain, setRelease, toString, updateAndGet, weakCompareAndSet, weakCompareAndSetAcquire, weakCompareAndSetPlain, weakCompareAndSetRelease, weakCompareAndSetVolatile

      • Methods inherited from class java.lang.Number

        byteValue, shortValue

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • child

        final Subscriber<? super T> child
        The actual child subscriber.

      • currentBuffer

        java.lang.Object[] currentBuffer
        Contains the reference to the buffer segment in replay. Accessed after reading state.size() and when emitting == true.

      • currentIndexInBuffer

        int currentIndexInBuffer
        Contains the index into the currentBuffer where the next value is expected. Accessed after reading state.size() and when emitting == true.

      • index

        int index
        Contains the absolute index up until the values have been replayed so far.

      • emitting

        boolean emitting
        Indicates there is a replay going on; guarded by this.

      • missed

        boolean missed
        Indicates there were some state changes/replay attempts; guarded by this.

    • Method Detail

      • request

        public void request​(long n)
        Description copied from interface: Producer
        Request a certain maximum number of items from this Producer. This is a way of requesting backpressure. To disable backpressure, pass Long.MAX_VALUE to this method.

        Requests are additive but if a sequence of requests totals more than Long.MAX_VALUE then Long.MAX_VALUE requests will be actioned and the extras may be ignored. Arriving at Long.MAX_VALUE by addition of requests cannot be assumed to disable backpressure. For example, the code below may result in Long.MAX_VALUE requests being actioned only. 

         request(100);
 request(Long.MAX_VALUE-1);
        Specified by:
        request in interface Producer
        Parameters:
        n - the maximum number of items you want this Producer to produce, or Long.MAX_VALUE if you want the Producer to produce items at its own pace

      • produced

        public long produced​(long n)
        Updates the request count to reflect values have been produced.
        Parameters:
        n - the produced item count, positive, not validated
        Returns:
        the latest request amount after subtracting n

      • isUnsubscribed

        public boolean isUnsubscribed()
        Description copied from interface: Subscription
        Indicates whether this Subscription is currently unsubscribed.
        Specified by:
        isUnsubscribed in interface Subscription
        Returns:
        true if this Subscription is currently unsubscribed, false otherwise

      • unsubscribe

        public void unsubscribe()
        Description copied from interface: Subscription
        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).

        Specified by:
        unsubscribe in interface Subscription

      • replay

        public void replay()
        Continue replaying available values if there are requests for them.