Class MpscSequencedArrayQueue<E>
- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- java.util.AbstractQueue<E>
-
- org.jctools.queues.ConcurrentCircularArrayQueueL0Pad<E>
-
- org.jctools.queues.ConcurrentCircularArrayQueue<E>
-
- org.jctools.queues.ConcurrentSequencedCircularArrayQueue<E>
-
- org.jctools.queues.MpscSequencedArrayQueueL1Pad<E>
-
- org.jctools.queues.MpscSequencedArrayQueueProducerField<E>
-
- org.jctools.queues.MpscSequencedArrayQueueL2Pad<E>
-
- org.jctools.queues.MpscSequencedArrayQueueConsumerField<E>
-
- org.jctools.queues.MpscSequencedArrayQueue<E>
-
- Type Parameters:
E
- type of the element stored in theQueue
- All Implemented Interfaces:
java.lang.Iterable<E>
,java.util.Collection<E>
,java.util.Queue<E>
,IndexedQueueSizeUtil.IndexedQueue
,MessagePassingQueue<E>
,QueueProgressIndicators
,SupportsIterator
public class MpscSequencedArrayQueue<E> extends MpscSequencedArrayQueueConsumerField<E>
A Multi-Producer-Single-Consumer queue based on same algorithm used forMpmcArrayQueue
but with the appropriate weakening of constraints on offer. The trade off does not seem worth while compared to the simplerMpscArrayQueue
.
-
-
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 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
-
Fields inherited from class org.jctools.queues.MpscSequencedArrayQueueConsumerField
consumerIndex
-
Fields inherited from class org.jctools.queues.ConcurrentSequencedCircularArrayQueue
sequenceBuffer
-
Fields inherited from class org.jctools.queues.ConcurrentCircularArrayQueue
buffer, mask
-
Fields inherited from class org.jctools.queues.ConcurrentCircularArrayQueueL0Pad
b170, b171, b172, b173, b174, b175, b176, b177
-
Fields inherited from interface org.jctools.queues.MessagePassingQueue
UNBOUNDED_CAPACITY
-
-
Constructor Summary
Constructors Constructor Description MpscSequencedArrayQueue(int capacity)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.void
drain(MessagePassingQueue.Consumer<E> c, MessagePassingQueue.WaitStrategy wait, MessagePassingQueue.ExitCondition exit)
Remove elements from the queue and hand to consume forever.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
offer(E e)
Called from a producer thread subject to the restrictions appropriate to the implementation and according to theQueue.offer(Object)
interface.E
peek()
Called from the consumer thread subject to the restrictions appropriate to the implementation and according to theQueue.peek()
interface.E
poll()
Called from the consumer thread subject to the restrictions appropriate to the implementation and according to theQueue.poll()
interface.boolean
relaxedOffer(E message)
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.-
Methods inherited from class org.jctools.queues.MpscSequencedArrayQueueConsumerField
lpConsumerIndex, lvConsumerIndex, soConsumerIndex
-
Methods inherited from class org.jctools.queues.MpscSequencedArrayQueueProducerField
casProducerIndex, lvProducerIndex
-
Methods inherited from class org.jctools.queues.ConcurrentCircularArrayQueue
capacity, clear, currentConsumerIndex, currentProducerIndex, isEmpty, iterator, size, toString
-
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
-
-
-
-
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
-
-
Method Detail
-
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 theQueue.offer(Object)
interface.- Parameters:
e
- notnull
, will throw NPE if it is- Returns:
- true if element was inserted into the queue, false iff full
-
poll
public E poll()
Description copied from interface:MessagePassingQueue
Called from the consumer thread subject to the restrictions appropriate to the implementation and according to theQueue.poll()
interface.- Returns:
- a message from the queue if one is available,
null
iff empty
-
peek
public E peek()
Description copied from interface:MessagePassingQueue
Called from the consumer thread subject to the restrictions appropriate to the implementation and according to theQueue.peek()
interface.- Returns:
- a message from the queue if one is available,
null
iff empty
-
relaxedOffer
public boolean relaxedOffer(E message)
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.- Parameters:
message
- notnull
, 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 toQueue.poll()
this method may returnnull
without the queue being empty.- 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 toQueue.peek()
this method may returnnull
without the queue being empty.- Returns:
- a message from the queue if one is available,
null
if unable to peek
-
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.- Returns:
- the number of polled elements
-
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.- Returns:
- the number of offered 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.- Returns:
- the number of polled elements
-
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.- Returns:
- the number of offered elements
-
drain
public void drain(MessagePassingQueue.Consumer<E> c, MessagePassingQueue.WaitStrategy wait, 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.
-
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.
-
-