Class MpscBlockingConsumerArrayQueue<E>
- All Implemented Interfaces:
Iterable<E>
,Collection<E>
,BlockingQueue<E>
,Queue<E>
,IndexedQueueSizeUtil.IndexedQueue
,MessagePassingQueue<E>
,QueueProgressIndicators
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
FieldsModifier and TypeFieldDescription(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
(package private) byte
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 -
Method Summary
Modifier and TypeMethodDescriptionint
capacity()
long
This method has no concurrent visibility semantics.long
This method has no concurrent visibility semantics.int
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, 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
(Collection<? super E> c) int
drainTo
(Collection<? super E> c, int maxElements) int
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.final boolean
isEmpty()
This method's accuracy is subject to concurrent modifications happening as the observation is carried out.iterator()
boolean
Called from a producer thread subject to the restrictions appropriate to the implementation and according to theQueue.offer(Object)
interface.boolean
private boolean
offerAndWakeup
(E[] buffer, long mask, long pIndex, E e) boolean
offerIfBelowThreshold
(E e, int threshold) private E
parkUntilNext
(E[] buffer, long cIndex, long offset, long timeoutNs) peek()
Called from the consumer thread subject to the restrictions appropriate to the implementation and according to theQueue.peek()
interface.poll()
Called from the consumer thread subject to the restrictions appropriate to the implementation and according to theQueue.poll()
interface.void
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.Called from the consumer thread subject to the restrictions appropriate to the implementation.Called from the consumer thread subject to the restrictions appropriate to the implementation.int
final 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) take()
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.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 java.util.concurrent.BlockingQueue
add, contains, remove
Methods inherited from interface java.util.Collection
addAll, clear, containsAll, equals, hashCode, parallelStream, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray, toArray
Methods inherited from interface org.jctools.queues.MessagePassingQueue
clear
-
Field Details
-
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 Details
-
MpscBlockingConsumerArrayQueue
public MpscBlockingConsumerArrayQueue(int capacity)
-
-
Method Details
-
iterator
- Specified by:
iterator
in interfaceCollection<E>
- Specified by:
iterator
in interfaceIterable<E>
- Specified by:
iterator
in classAbstractCollection<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 interfaceCollection<E>
- Specified by:
size
in interfaceMessagePassingQueue<E>
- Specified by:
size
in classAbstractCollection<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 interfaceCollection<E>
- Specified by:
isEmpty
in interfaceMessagePassingQueue<E>
- Overrides:
isEmpty
in classAbstractCollection<E>
- Returns:
- true if empty, false otherwise
-
toString
- Overrides:
toString
in classAbstractCollection<E>
-
offerIfBelowThreshold
- Parameters:
e
- the object to offer onto the queue, not nullthreshold
- the maximum allowable size- Returns:
- true if the offer is successful, false if queue size exceeds threshold
- Since:
- 3.0.1
-
offer
Description copied from interface:MessagePassingQueue
Called from a producer thread subject to the restrictions appropriate to the implementation and according to theQueue.offer(Object)
interface.- Specified by:
offer
in interfaceBlockingQueue<E>
- Specified by:
offer
in interfaceMessagePassingQueue<E>
- Specified by:
offer
in interfaceQueue<E>
- Parameters:
e
- notnull
, will throw NPE if it is- Returns:
- true if element was inserted into the queue, false iff full
-
put
- Specified by:
put
in interfaceBlockingQueue<E>
- Throws:
InterruptedException
-
offer
- Specified by:
offer
in interfaceBlockingQueue<E>
- Throws:
InterruptedException
-
offerAndWakeup
-
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
This implementation is correct for single consumer thread use only.
- Specified by:
take
in interfaceBlockingQueue<E>
- Throws:
InterruptedException
-
poll
This implementation is correct for single consumer thread use only.
- Specified by:
poll
in interfaceBlockingQueue<E>
- Throws:
InterruptedException
-
parkUntilNext
private E parkUntilNext(E[] buffer, long cIndex, long offset, long timeoutNs) throws InterruptedException - Throws:
InterruptedException
-
remainingCapacity
public int remainingCapacity()- Specified by:
remainingCapacity
in interfaceBlockingQueue<E>
-
drainTo
- Specified by:
drainTo
in interfaceBlockingQueue<E>
-
drainTo
- Specified by:
drainTo
in interfaceBlockingQueue<E>
-
poll
Called from the consumer thread subject to the restrictions appropriate to the implementation and according to theQueue.poll()
interface.This implementation is correct for single consumer thread use only.
-
spinWaitForElement
private static <E> E spinWaitForElement(E[] buffer, long offset) -
peek
Called from the consumer thread subject to the restrictions appropriate to the implementation and according to theQueue.peek()
interface.This implementation is correct for single consumer thread use only.
-
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 interfaceQueueProgressIndicators
- 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 interfaceQueueProgressIndicators
- Returns:
- the current value of the consumer progress index
-
capacity
public int capacity()- Specified by:
capacity
in interfaceIndexedQueueSizeUtil.IndexedQueue
- Specified by:
capacity
in interfaceMessagePassingQueue<E>
- Returns:
- the capacity of this queue or
MessagePassingQueue.UNBOUNDED_CAPACITY
if not bounded
-
relaxedOffer
Description copied from interface:MessagePassingQueue
Called from a producer thread subject to the restrictions appropriate to the implementation. As opposed toQueue.offer(Object)
this method may return false without the queue being full.- Specified by:
relaxedOffer
in interfaceMessagePassingQueue<E>
- Parameters:
e
- notnull
, will throw NPE if it is- Returns:
- true if element was inserted into the queue, false if unable to offer
-
relaxedPoll
Description copied from interface:MessagePassingQueue
Called from the consumer thread subject to the restrictions appropriate to the implementation. As opposed toQueue.poll()
this method may returnnull
without the queue being empty.- Specified by:
relaxedPoll
in interfaceMessagePassingQueue<E>
- Returns:
- a message from the queue if one is available,
null
if unable to poll
-
relaxedPeek
Description copied from interface:MessagePassingQueue
Called from the consumer thread subject to the restrictions appropriate to the implementation. As opposed toQueue.peek()
this method may returnnull
without the queue being empty.- Specified by:
relaxedPeek
in interfaceMessagePassingQueue<E>
- Returns:
- a message from the queue if one is available,
null
if unable to peek
-
fill
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 interfaceMessagePassingQueue<E>
- Returns:
- the number of offered elements
-
drain
public int drain(MessagePassingQueue.Consumer<E> c, int limit, long timeout, TimeUnit unit) throws 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
MessagePassingQueue.Consumer.accept(T)
make sure you have read and understood these before using this method.- Returns:
- the number of polled elements
- Throws:
InterruptedException
- if interrupted while waitingIllegalArgumentException
- c isnull
IllegalArgumentException
- if limit is negative
-
fill
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 interfaceMessagePassingQueue<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 toMessagePassingQueue.Supplier.get()
make sure you have read and understood these before using this method.- Specified by:
fill
in interfaceMessagePassingQueue<E>
-
drain
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 interfaceMessagePassingQueue<E>
- Returns:
- the number of polled elements
-
drain
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 interfaceMessagePassingQueue<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 interfaceMessagePassingQueue<E>
-