Package rx.internal.operators

Class OnSubscribePublishMulticast.PublishProducer<T>

  • Type Parameters:
    T - the output value type
    All Implemented Interfaces:
    java.io.Serializable, Producer, Subscription
    Enclosing class:
    OnSubscribePublishMulticast<T>
    static final class OnSubscribePublishMulticast.PublishProducer<T>
extends java.util.concurrent.atomic.AtomicLong
implements Producer, Subscription
    A Producer and Subscription that wraps a child Subscriber and manages its backpressure requests along with its unsubscription from the parent class.

    The class extends AtomicLong that holds onto the child's requested amount.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      (package private) Subscriber<? super T> actual
      The actual subscriber to receive the events.
      (package private) java.util.concurrent.atomic.AtomicBoolean once
      Makes sure unsubscription happens only once.
      (package private) OnSubscribePublishMulticast<T> parent
      The parent object to request draining or removal.
      private static long serialVersionUID  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean isUnsubscribed()
      Indicates whether this Subscription is currently unsubscribed.
      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

      • actual

        final Subscriber<? super T> actual
        The actual subscriber to receive the events.

      • once

        final java.util.concurrent.atomic.AtomicBoolean once
        Makes sure unsubscription happens only once.

    • 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

      • 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