MpscBlockingConsumerArrayQueue

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractQueue<E>
  - - org.jctools.queues.MpscBlockingConsumerArrayQueuePad1<E>
    - - org.jctools.queues.MpscBlockingConsumerArrayQueueColdProducerFields<E>
      - org.jctools.queues.MpscBlockingConsumerArrayQueuePad2<E>
        
        org.jctools.queues.MpscBlockingConsumerArrayQueueProducerFields<E>
        
        org.jctools.queues.MpscBlockingConsumerArrayQueuePad3<E>
        
        org.jctools.queues.MpscBlockingConsumerArrayQueueConsumerFields<E>
        
        org.jctools.queues.MpscBlockingConsumerArrayQueue<E>

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, java.util.concurrent.BlockingQueue<E>, java.util.Queue<E>, IndexedQueueSizeUtil.IndexedQueue, MessagePassingQueue<E>, QueueProgressIndicators
```
public class MpscBlockingConsumerArrayQueue<E>
extends MpscBlockingConsumerArrayQueueConsumerFields<E>
implements MessagePassingQueue<E>, QueueProgressIndicators, java.util.concurrent.BlockingQueue<E>
```
This is a partial implementation of the BlockingQueue on the consumer side only on top of the mechanics described in BaseMpscLinkedArrayQueue, but with the reservation bit used for blocking rather than resizing in this instance.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.jctools.queues.MessagePassingQueue
  MessagePassingQueue.Consumer<T>, MessagePassingQueue.ExitCondition, MessagePassingQueue.Supplier<T>, MessagePassingQueue.WaitStrategy

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) byte`	`b000`
`(package private) byte`	`b001`
`(package private) byte`	`b002`
`(package private) byte`	`b003`
`(package private) byte`	`b004`
`(package private) byte`	`b005`
`(package private) byte`	`b006`
`(package private) byte`	`b007`
`(package private) byte`	`b010`
`(package private) byte`	`b011`
`(package private) byte`	`b012`
`(package private) byte`	`b013`
`(package private) byte`	`b014`
`(package private) byte`	`b015`
`(package private) byte`	`b016`
`(package private) byte`	`b017`
`(package private) byte`	`b020`
`(package private) byte`	`b021`
`(package private) byte`	`b022`
`(package private) byte`	`b023`
`(package private) byte`	`b024`
`(package private) byte`	`b025`
`(package private) byte`	`b026`
`(package private) byte`	`b027`
`(package private) byte`	`b030`
`(package private) byte`	`b031`
`(package private) byte`	`b032`
`(package private) byte`	`b033`
`(package private) byte`	`b034`
`(package private) byte`	`b035`
`(package private) byte`	`b036`
`(package private) byte`	`b037`
`(package private) byte`	`b040`
`(package private) byte`	`b041`
`(package private) byte`	`b042`
`(package private) byte`	`b043`
`(package private) byte`	`b044`
`(package private) byte`	`b045`
`(package private) byte`	`b046`
`(package private) byte`	`b047`
`(package private) byte`	`b050`
`(package private) byte`	`b051`
`(package private) byte`	`b052`
`(package private) byte`	`b053`
`(package private) byte`	`b054`
`(package private) byte`	`b055`
`(package private) byte`	`b056`
`(package private) byte`	`b057`
`(package private) byte`	`b060`
`(package private) byte`	`b061`
`(package private) byte`	`b062`
`(package private) byte`	`b063`
`(package private) byte`	`b064`
`(package private) byte`	`b065`
`(package private) byte`	`b066`
`(package private) byte`	`b067`
`(package private) byte`	`b070`
`(package private) byte`	`b071`
`(package private) byte`	`b072`
`(package private) byte`	`b073`
`(package private) byte`	`b074`
`(package private) byte`	`b075`
`(package private) byte`	`b076`
`(package private) byte`	`b077`
`(package private) byte`	`b100`
`(package private) byte`	`b101`
`(package private) byte`	`b102`
`(package private) byte`	`b103`
`(package private) byte`	`b104`
`(package private) byte`	`b105`
`(package private) byte`	`b106`
`(package private) byte`	`b107`
`(package private) byte`	`b110`
`(package private) byte`	`b111`
`(package private) byte`	`b112`
`(package private) byte`	`b113`
`(package private) byte`	`b114`
`(package private) byte`	`b115`
`(package private) byte`	`b116`
`(package private) byte`	`b117`
`(package private) byte`	`b120`
`(package private) byte`	`b121`
`(package private) byte`	`b122`
`(package private) byte`	`b123`
`(package private) byte`	`b124`
`(package private) byte`	`b125`
`(package private) byte`	`b126`
`(package private) byte`	`b127`
`(package private) byte`	`b130`
`(package private) byte`	`b131`
`(package private) byte`	`b132`
`(package private) byte`	`b133`
`(package private) byte`	`b134`
`(package private) byte`	`b135`
`(package private) byte`	`b136`
`(package private) byte`	`b137`
`(package private) byte`	`b140`
`(package private) byte`	`b141`
`(package private) byte`	`b142`
`(package private) byte`	`b143`
`(package private) byte`	`b144`
`(package private) byte`	`b145`
`(package private) byte`	`b146`
`(package private) byte`	`b147`
`(package private) byte`	`b150`
`(package private) byte`	`b151`
`(package private) byte`	`b152`
`(package private) byte`	`b153`
`(package private) byte`	`b154`
`(package private) byte`	`b155`
`(package private) byte`	`b156`
`(package private) byte`	`b157`
`(package private) byte`	`b160`
`(package private) byte`	`b161`
`(package private) byte`	`b162`
`(package private) byte`	`b163`
`(package private) byte`	`b164`
`(package private) byte`	`b165`
`(package private) byte`	`b166`
`(package private) byte`	`b167`
`(package private) byte`	`b170`
`(package private) byte`	`b171`
`(package private) byte`	`b172`
`(package private) byte`	`b173`
`(package private) byte`	`b174`
`(package private) byte`	`b175`
`(package private) byte`	`b176`
`(package private) byte`	`b177`

Fields inherited from class org.jctools.queues.MpscBlockingConsumerArrayQueueConsumerFields
consumerBuffer, consumerMask

Fields inherited from class org.jctools.queues.MpscBlockingConsumerArrayQueueColdProducerFields
producerBuffer, producerMask

Fields inherited from interface org.jctools.queues.MessagePassingQueue
UNBOUNDED_CAPACITY

Constructor Summary

Constructors
Constructor and Description

MpscBlockingConsumerArrayQueue(int capacity)

Constructors
Constructor and Description
`MpscBlockingConsumerArrayQueue(int capacity)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`capacity()`
`long`	`currentConsumerIndex()` This method has no concurrent visibility semantics.
`long`	`currentProducerIndex()` This method has no concurrent visibility semantics.
`int`	`drain(MessagePassingQueue.Consumer<E> c)` Remove all available item from the queue and hand to consume.
`int`	`drain(MessagePassingQueue.Consumer<E> c, int limit)` Remove up to limit elements from the queue and hand to consume.
`int`	`drain(MessagePassingQueue.Consumer<E> c, int limit, long timeout, java.util.concurrent.TimeUnit unit)` Remove up to limit elements from the queue and hand to consume, waiting up to the specified wait time if necessary for an element to become available.
`void`	`drain(MessagePassingQueue.Consumer<E> c, MessagePassingQueue.WaitStrategy w, MessagePassingQueue.ExitCondition exit)` Remove elements from the queue and hand to consume forever.
`int`	`drainTo(java.util.Collection<? super E> c)`
`int`	`drainTo(java.util.Collection<? super E> c, int maxElements)`
`int`	`fill(MessagePassingQueue.Supplier<E> s)` Stuff the queue with elements from the supplier.
`int`	`fill(MessagePassingQueue.Supplier<E> s, int limit)` Stuff the queue with up to limit elements from the supplier.
`void`	`fill(MessagePassingQueue.Supplier<E> s, MessagePassingQueue.WaitStrategy wait, MessagePassingQueue.ExitCondition exit)` Stuff the queue with elements from the supplier forever.
`boolean`	`isEmpty()` This method's accuracy is subject to concurrent modifications happening as the observation is carried out.
`java.util.Iterator<E>`	`iterator()`
`boolean`	`offer(E e)` Called from a producer thread subject to the restrictions appropriate to the implementation and according to the `Queue.offer(Object)` interface.
`boolean`	`offer(E e, long timeout, java.util.concurrent.TimeUnit unit)`
`private boolean`	`offerAndWakeup(E[] buffer, long mask, long pIndex, E e)`
`boolean`	`offerIfBelowThreshold(E e, int threshold)` `offer(E)` if `size()` is less than threshold.
`private E`	`parkUntilNext(E[] buffer, long cIndex, long offset, long timeoutNs)`
`E`	`peek()` Called from the consumer thread subject to the restrictions appropriate to the implementation and according to the `Queue.peek()` interface.
`E`	`poll()` Called from the consumer thread subject to the restrictions appropriate to the implementation and according to the `Queue.poll()` interface.
`E`	`poll(long timeout, java.util.concurrent.TimeUnit unit)`
`void`	`put(E e)`
`private boolean`	`recalculateProducerLimit(long mask, long pIndex, long producerLimit)`
`private boolean`	`recalculateProducerLimit(long pIndex, long producerLimit, long cIndex, long bufferCapacity, long threshold)`
`boolean`	`relaxedOffer(E e)` Called from a producer thread subject to the restrictions appropriate to the implementation.
`E`	`relaxedPeek()` Called from the consumer thread subject to the restrictions appropriate to the implementation.
`E`	`relaxedPoll()` Called from the consumer thread subject to the restrictions appropriate to the implementation.
`int`	`remainingCapacity()`
`int`	`size()` This method's accuracy is subject to concurrent modifications happening as the size is estimated and as such is a best effort rather than absolute value.
`private static <E> E`	`spinWaitForElement(E[] buffer, long offset)`
`E`	`take()`
`java.lang.String`	`toString()`

Methods inherited from class org.jctools.queues.MpscBlockingConsumerArrayQueueConsumerFields
lpConsumerIndex, lvBlocked, lvConsumerIndex, soBlocked, soConsumerIndex

Methods inherited from class org.jctools.queues.MpscBlockingConsumerArrayQueueProducerFields
casProducerIndex, lvProducerIndex, soProducerIndex

Methods inherited from class org.jctools.queues.MpscBlockingConsumerArrayQueueColdProducerFields
casProducerLimit, lvProducerLimit, soProducerLimit

Methods inherited from class java.util.AbstractQueue
add, addAll, clear, element, remove

Methods inherited from class java.util.AbstractCollection
contains, containsAll, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jctools.queues.MessagePassingQueue
clear

Methods inherited from interface java.util.concurrent.BlockingQueue
add, contains, remove

Methods inherited from interface java.util.Queue
element, remove

Methods inherited from interface java.util.Collection
addAll, clear, containsAll, equals, hashCode, parallelStream, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable
forEach

- Field Detail
  - b000
```
byte b000
```
  - b001
```
byte b001
```
  - b002
```
byte b002
```
  - b003
```
byte b003
```
  - b004
```
byte b004
```
  - b005
```
byte b005
```
  - b006
```
byte b006
```
  - b007
```
byte b007
```
  - b010
```
byte b010
```
  - b011
```
byte b011
```
  - b012
```
byte b012
```
  - b013
```
byte b013
```
  - b014
```
byte b014
```
  - b015
```
byte b015
```
  - b016
```
byte b016
```
  - b017
```
byte b017
```
  - b020
```
byte b020
```
  - b021
```
byte b021
```
  - b022
```
byte b022
```
  - b023
```
byte b023
```
  - b024
```
byte b024
```
  - b025
```
byte b025
```
  - b026
```
byte b026
```
  - b027
```
byte b027
```
  - b030
```
byte b030
```
  - b031
```
byte b031
```
  - b032
```
byte b032
```
  - b033
```
byte b033
```
  - b034
```
byte b034
```
  - b035
```
byte b035
```
  - b036
```
byte b036
```
  - b037
```
byte b037
```
  - b040
```
byte b040
```
  - b041
```
byte b041
```
  - b042
```
byte b042
```
  - b043
```
byte b043
```
  - b044
```
byte b044
```
  - b045
```
byte b045
```
  - b046
```
byte b046
```
  - b047
```
byte b047
```
  - b050
```
byte b050
```
  - b051
```
byte b051
```
  - b052
```
byte b052
```
  - b053
```
byte b053
```
  - b054
```
byte b054
```
  - b055
```
byte b055
```
  - b056
```
byte b056
```
  - b057
```
byte b057
```
  - b060
```
byte b060
```
  - b061
```
byte b061
```
  - b062
```
byte b062
```
  - b063
```
byte b063
```
  - b064
```
byte b064
```
  - b065
```
byte b065
```
  - b066
```
byte b066
```
  - b067
```
byte b067
```
  - b070
```
byte b070
```
  - b071
```
byte b071
```
  - b072
```
byte b072
```
  - b073
```
byte b073
```
  - b074
```
byte b074
```
  - b075
```
byte b075
```
  - b076
```
byte b076
```
  - b077
```
byte b077
```
  - b100
```
byte b100
```
  - b101
```
byte b101
```
  - b102
```
byte b102
```
  - b103
```
byte b103
```
  - b104
```
byte b104
```
  - b105
```
byte b105
```
  - b106
```
byte b106
```
  - b107
```
byte b107
```
  - b110
```
byte b110
```
  - b111
```
byte b111
```
  - b112
```
byte b112
```
  - b113
```
byte b113
```
  - b114
```
byte b114
```
  - b115
```
byte b115
```
  - b116
```
byte b116
```
  - b117
```
byte b117
```
  - b120
```
byte b120
```
  - b121
```
byte b121
```
  - b122
```
byte b122
```
  - b123
```
byte b123
```
  - b124
```
byte b124
```
  - b125
```
byte b125
```
  - b126
```
byte b126
```
  - b127
```
byte b127
```
  - b130
```
byte b130
```
  - b131
```
byte b131
```
  - b132
```
byte b132
```
  - b133
```
byte b133
```
  - b134
```
byte b134
```
  - b135
```
byte b135
```
  - b136
```
byte b136
```
  - b137
```
byte b137
```
  - b140
```
byte b140
```
  - b141
```
byte b141
```
  - b142
```
byte b142
```
  - b143
```
byte b143
```
  - b144
```
byte b144
```
  - b145
```
byte b145
```
  - b146
```
byte b146
```
  - b147
```
byte b147
```
  - b150
```
byte b150
```
  - b151
```
byte b151
```
  - b152
```
byte b152
```
  - b153
```
byte b153
```
  - b154
```
byte b154
```
  - b155
```
byte b155
```
  - b156
```
byte b156
```
  - b157
```
byte b157
```
  - b160
```
byte b160
```
  - b161
```
byte b161
```
  - b162
```
byte b162
```
  - b163
```
byte b163
```
  - b164
```
byte b164
```
  - b165
```
byte b165
```
  - b166
```
byte b166
```
  - b167
```
byte b167
```
  - b170
```
byte b170
```
  - b171
```
byte b171
```
  - b172
```
byte b172
```
  - b173
```
byte b173
```
  - b174
```
byte b174
```
  - b175
```
byte b175
```
  - b176
```
byte b176
```
  - b177
```
byte b177
```
- Constructor Detail
  - MpscBlockingConsumerArrayQueue
```
public MpscBlockingConsumerArrayQueue(int capacity)
```
- Method Detail
  - iterator
```
public final java.util.Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<E>
    
    Specified by:
    
    iterator in interface java.util.Collection<E>
    
    Specified by:
    
    iterator in class java.util.AbstractCollection<E>
  - size
```
public final int size()
```
    Description copied from interface: MessagePassingQueue
    
    This method's accuracy is subject to concurrent modifications happening as the size is estimated and as such is a best effort rather than absolute value. For some implementations this method may be O(n) rather than O(1).
    
    Specified by:
    
    size in interface java.util.Collection<E>
    
    Specified by:
    
    size in interface MessagePassingQueue<E>
    
    Specified by:
    
    size in class java.util.AbstractCollection<E>
    
    Returns:
    
    number of messages in the queue, between 0 and Integer.MAX_VALUE but less or equals to capacity (if bounded).
  - isEmpty
```
public final boolean isEmpty()
```
    Description copied from interface: MessagePassingQueue
    
    This method's accuracy is subject to concurrent modifications happening as the observation is carried out.
    
    Specified by:
    
    isEmpty in interface java.util.Collection<E>
    
    Specified by:
    
    isEmpty in interface MessagePassingQueue<E>
    
    Overrides:
    
    isEmpty in class java.util.AbstractCollection<E>
    
    Returns:
    
    true if empty, false otherwise
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.util.AbstractCollection<E>
  - offerIfBelowThreshold
```
public boolean offerIfBelowThreshold(E e,
                                     int threshold)
```
    offer(E) if size() is less than threshold.
    
    Parameters:
    
    e - the object to offer onto the queue, not null
    
    threshold - the maximum allowable size
    
    Returns:
    
    true if the offer is successful, false if queue size exceeds threshold
    
    Since:
    
    3.0.1
  - offer
```
public boolean offer(E e)
```
    Description copied from interface: MessagePassingQueue
    
    Called from a producer thread subject to the restrictions appropriate to the implementation and according to the Queue.offer(Object) interface.
    
    Specified by:
    
    offer in interface java.util.concurrent.BlockingQueue<E>
    
    Specified by:
    
    offer in interface java.util.Queue<E>
    
    Specified by:
    
    offer in interface MessagePassingQueue<E>
    
    Parameters:
    
    e - not null, will throw NPE if it is
    
    Returns:
    
    true if element was inserted into the queue, false iff full
  - put
```
public void put(E e)
         throws java.lang.InterruptedException
```
    Specified by:
    
    put in interface java.util.concurrent.BlockingQueue<E>
    
    Throws:
    
    java.lang.InterruptedException
  - offer
```
public boolean offer(E e,
                     long timeout,
                     java.util.concurrent.TimeUnit unit)
              throws java.lang.InterruptedException
```
    Specified by:
    
    offer in interface java.util.concurrent.BlockingQueue<E>
    
    Throws:
    
    java.lang.InterruptedException
  - offerAndWakeup
```
private boolean offerAndWakeup(E[] buffer,
                               long mask,
                               long pIndex,
                               E e)
```
  - recalculateProducerLimit
```
private boolean recalculateProducerLimit(long mask,
                                         long pIndex,
                                         long producerLimit)
```
  - recalculateProducerLimit
```
private boolean recalculateProducerLimit(long pIndex,
                                         long producerLimit,
                                         long cIndex,
                                         long bufferCapacity,
                                         long threshold)
```
  - take
```
public E take()
       throws java.lang.InterruptedException
```
    This implementation is correct for single consumer thread use only.
    
    Specified by:
    
    take in interface java.util.concurrent.BlockingQueue<E>
    
    Throws:
    
    java.lang.InterruptedException
  - poll
```
public E poll(long timeout,
              java.util.concurrent.TimeUnit unit)
       throws java.lang.InterruptedException
```
    This implementation is correct for single consumer thread use only.
    
    Specified by:
    
    poll in interface java.util.concurrent.BlockingQueue<E>
    
    Throws:
    
    java.lang.InterruptedException
  - parkUntilNext
```
private E parkUntilNext(E[] buffer,
                        long cIndex,
                        long offset,
                        long timeoutNs)
                 throws java.lang.InterruptedException
```
    Throws:
    
    java.lang.InterruptedException
  - remainingCapacity
```
public int remainingCapacity()
```
    Specified by:
    
    remainingCapacity in interface java.util.concurrent.BlockingQueue<E>
  - drainTo
```
public int drainTo(java.util.Collection<? super E> c)
```
    Specified by:
    
    drainTo in interface java.util.concurrent.BlockingQueue<E>
  - drainTo
```
public int drainTo(java.util.Collection<? super E> c,
                   int maxElements)
```
    Specified by:
    
    drainTo in interface java.util.concurrent.BlockingQueue<E>
  - poll
```
public E poll()
```
    Called from the consumer thread subject to the restrictions appropriate to the implementation and according to the Queue.poll() interface.
    This implementation is correct for single consumer thread use only.
    
    Specified by:
    
    poll in interface java.util.Queue<E>
    
    Specified by:
    
    poll in interface MessagePassingQueue<E>
    
    Returns:
    
    a message from the queue if one is available, null iff empty
  - spinWaitForElement
```
private static <E> E spinWaitForElement(E[] buffer,
                                        long offset)
```
  - peek
```
public E peek()
```
    Called from the consumer thread subject to the restrictions appropriate to the implementation and according to the Queue.peek() interface.
    This implementation is correct for single consumer thread use only.
    
    Specified by:
    
    peek in interface java.util.Queue<E>
    
    Specified by:
    
    peek in interface MessagePassingQueue<E>
    
    Returns:
    
    a message from the queue if one is available, null iff empty
  - currentProducerIndex
```
public long currentProducerIndex()
```
    Description copied from interface: QueueProgressIndicators
    
    This method has no concurrent visibility semantics. The value returned may be negative. Under normal circumstances 2 consecutive calls to this method can offer an idea of progress made by producer threads by subtracting the 2 results though in extreme cases (if producers have progressed by more than 2^64) this may also fail.
    This value will normally indicate number of elements passed into the queue, but may under some circumstances be a derivative of that figure. This method should not be used to derive size or emptiness.
    
    Specified by:
    
    currentProducerIndex in interface QueueProgressIndicators
    
    Returns:
    
    the current value of the producer progress index
  - currentConsumerIndex
```
public long currentConsumerIndex()
```
    Description copied from interface: QueueProgressIndicators
    
    This method has no concurrent visibility semantics. The value returned may be negative. Under normal circumstances 2 consecutive calls to this method can offer an idea of progress made by consumer threads by subtracting the 2 results though in extreme cases (if consumers have progressed by more than 2^64) this may also fail.
    This value will normally indicate number of elements taken out of the queue, but may under some circumstances be a derivative of that figure. This method should not be used to derive size or emptiness.
    
    Specified by:
    
    currentConsumerIndex in interface QueueProgressIndicators
    
    Returns:
    
    the current value of the consumer progress index
  - capacity
```
public int capacity()
```
    Specified by:
    
    capacity in interface IndexedQueueSizeUtil.IndexedQueue
    
    Specified by:
    
    capacity in interface MessagePassingQueue<E>
    
    Returns:
    
    the capacity of this queue or MessagePassingQueue.UNBOUNDED_CAPACITY if not bounded
  - relaxedOffer
```
public boolean relaxedOffer(E e)
```
    Description copied from interface: MessagePassingQueue
    
    Called from a producer thread subject to the restrictions appropriate to the implementation. As opposed to Queue.offer(Object) this method may return false without the queue being full.
    
    Specified by:
    
    relaxedOffer in interface MessagePassingQueue<E>
    
    Parameters:
    
    e - not null, will throw NPE if it is
    
    Returns:
    
    true if element was inserted into the queue, false if unable to offer
  - relaxedPoll
```
public E relaxedPoll()
```
    Description copied from interface: MessagePassingQueue
    
    Called from the consumer thread subject to the restrictions appropriate to the implementation. As opposed to Queue.poll() this method may return null without the queue being empty.
    
    Specified by:
    
    relaxedPoll in interface MessagePassingQueue<E>
    
    Returns:
    
    a message from the queue if one is available, null if unable to poll
  - relaxedPeek
```
public E relaxedPeek()
```
    Description copied from interface: MessagePassingQueue
    
    Called from the consumer thread subject to the restrictions appropriate to the implementation. As opposed to Queue.peek() this method may return null without the queue being empty.
    
    Specified by:
    
    relaxedPeek in interface MessagePassingQueue<E>
    
    Returns:
    
    a message from the queue if one is available, null if unable to peek
  - fill
```
public int fill(MessagePassingQueue.Supplier<E> s,
                int limit)
```
    Description copied from interface: MessagePassingQueue
    Stuff the queue with up to limit elements from the supplier. Semantically similar to:
```
   for(int i=0; i < limit && relaxedOffer(s.get()); i++);
 
```
    There's no strong commitment to the queue being full at the end of a fill. Called from a producer thread subject to the restrictions appropriate to the implementation. WARNING: Explicit assumptions are made with regards to MessagePassingQueue.Supplier.get() make sure you have read and understood these before using this method.
    Specified by:
    
    fill in interface MessagePassingQueue<E>
    
    Returns:
    
    the number of offered elements
  - drain
```
public int drain(MessagePassingQueue.Consumer<E> c,
                 int limit,
                 long timeout,
                 java.util.concurrent.TimeUnit unit)
          throws java.lang.InterruptedException
```
    Remove up to limit elements from the queue and hand to consume, waiting up to the specified wait time if necessary for an element to become available.
    There's no strong commitment to the queue being empty at the end of it. This implementation is correct for single consumer thread use only.
    WARNING: Explicit assumptions are made with regards to Consumer#accept make sure you have read and understood these before using this method.
    
    Returns:
    
    the number of polled elements
    
    Throws:
    
    java.lang.InterruptedException - if interrupted while waiting
    
    java.lang.IllegalArgumentException - c is null
    
    java.lang.IllegalArgumentException - if limit is negative
  - fill
```
public int fill(MessagePassingQueue.Supplier<E> s)
```
    Description copied from interface: MessagePassingQueue
    Stuff the queue with elements from the supplier. Semantically similar to:
```
 while(relaxedOffer(s.get());
 
```
    There's no strong commitment to the queue being full at the end of a fill. Called from a producer thread subject to the restrictions appropriate to the implementation.
    Unbounded queues will fill up the queue with a fixed amount rather than fill up to oblivion. WARNING: Explicit assumptions are made with regards to MessagePassingQueue.Supplier.get() make sure you have read and understood these before using this method.
    Specified by:
    
    fill in interface MessagePassingQueue<E>
    
    Returns:
    
    the number of offered elements
  - fill
```
public void fill(MessagePassingQueue.Supplier<E> s,
                 MessagePassingQueue.WaitStrategy wait,
                 MessagePassingQueue.ExitCondition exit)
```
    Description copied from interface: MessagePassingQueue
    Stuff the queue with elements from the supplier forever. Semantically similar to:
```
 
  int idleCounter = 0;
  while (exit.keepRunning()) {
      E e = s.get();
      while (!relaxedOffer(e)) {
          idleCounter = wait.idle(idleCounter);
          continue;
      }
      idleCounter = 0;
  }
 
 
```
    Called from a producer thread subject to the restrictions appropriate to the implementation. The main difference being that implementors MUST assure room in the queue is available BEFORE calling MessagePassingQueue.Supplier.get(). WARNING: Explicit assumptions are made with regards to MessagePassingQueue.Supplier.get() make sure you have read and understood these before using this method.
    Specified by:
    
    fill in interface MessagePassingQueue<E>
  - drain
```
public int drain(MessagePassingQueue.Consumer<E> c)
```
    Description copied from interface: MessagePassingQueue
    Remove all available item from the queue and hand to consume. This should be semantically similar to:
```
 M m;
 while((m = relaxedPoll()) != null){
 c.accept(m);
 }
 
```
    There's no strong commitment to the queue being empty at the end of a drain. Called from a consumer thread subject to the restrictions appropriate to the implementation.
    WARNING: Explicit assumptions are made with regards to MessagePassingQueue.Consumer.accept(T) make sure you have read and understood these before using this method.
    Specified by:
    
    drain in interface MessagePassingQueue<E>
    
    Returns:
    
    the number of polled elements
  - drain
```
public int drain(MessagePassingQueue.Consumer<E> c,
                 int limit)
```
    Description copied from interface: MessagePassingQueue
    Remove up to limit elements from the queue and hand to consume. This should be semantically similar to:
```
   M m;
   int i = 0;
   for(;i < limit && (m = relaxedPoll()) != null; i++){
     c.accept(m);
   }
   return i;
 
```
    There's no strong commitment to the queue being empty at the end of a drain. Called from a consumer thread subject to the restrictions appropriate to the implementation.
    WARNING: Explicit assumptions are made with regards to MessagePassingQueue.Consumer.accept(T) make sure you have read and understood these before using this method.
    Specified by:
    
    drain in interface MessagePassingQueue<E>
    
    Returns:
    
    the number of polled elements
  - drain
```
public void drain(MessagePassingQueue.Consumer<E> c,
                  MessagePassingQueue.WaitStrategy w,
                  MessagePassingQueue.ExitCondition exit)
```
    Description copied from interface: MessagePassingQueue
    Remove elements from the queue and hand to consume forever. Semantically similar to:
```
  int idleCounter = 0;
  while (exit.keepRunning()) {
      E e = relaxedPoll();
      if(e==null){
          idleCounter = wait.idle(idleCounter);
          continue;
      }
      idleCounter = 0;
      c.accept(e);
  }
 
```
    Called from a consumer thread subject to the restrictions appropriate to the implementation.
    WARNING: Explicit assumptions are made with regards to MessagePassingQueue.Consumer.accept(T) make sure you have read and understood these before using this method.
    Specified by:
    
    drain in interface MessagePassingQueue<E>

Class MpscBlockingConsumerArrayQueue<E>

Nested Class Summary

Nested classes/interfaces inherited from interface org.jctools.queues.MessagePassingQueue

Field Summary

Fields inherited from class org.jctools.queues.MpscBlockingConsumerArrayQueueConsumerFields

Fields inherited from class org.jctools.queues.MpscBlockingConsumerArrayQueueColdProducerFields

Fields inherited from interface org.jctools.queues.MessagePassingQueue

Constructor Summary

Method Summary

Methods inherited from class org.jctools.queues.MpscBlockingConsumerArrayQueueConsumerFields

Methods inherited from class org.jctools.queues.MpscBlockingConsumerArrayQueueProducerFields

Methods inherited from class org.jctools.queues.MpscBlockingConsumerArrayQueueColdProducerFields

Methods inherited from class java.util.AbstractQueue

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface org.jctools.queues.MessagePassingQueue

Methods inherited from interface java.util.concurrent.BlockingQueue

Methods inherited from interface java.util.Queue

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Field Detail

b000

b001

b002

b003

b004

b005

b006

b007

b010

b011

b012

b013

b014

b015

b016

b017

b020

b021

b022

b023

b024

b025

b026

b027

b030

b031

b032

b033

b034

b035

b036

b037

b040

b041

b042

b043

b044

b045

b046

b047

b050

b051

b052

b053

b054

b055

b056

b057

b060

b061

b062

b063

b064

b065

b066

b067

b070

b071

b072