Class SingleProducer<T>

java.lang.Object
java.util.concurrent.atomic.AtomicBoolean
rx.internal.producers.SingleProducer<T>
Type Parameters:
T - the value type
All Implemented Interfaces:
Serializable, Producer

public final class SingleProducer<T> extends AtomicBoolean implements Producer
A producer which emits a single value and completes the child on the first positive request.
See Also:
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:
    • child

      final Subscriber<? super T> child
      The child subscriber.
    • value

      final T value
      The value to be emitted.
  • Constructor Details

    • SingleProducer

      public SingleProducer(Subscriber<? super T> child, T value)
      Constructs the producer with the given target child and value to be emitted.
      Parameters:
      child - the child subscriber, non-null
      value - the value to be emitted, may be null
  • Method Details

    • 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