Class MpscUnboundedXaddArrayQueue<E>
- All Implemented Interfaces:
Iterable<E>
,Collection<E>
,Queue<E>
,IndexedQueueSizeUtil.IndexedQueue
,MessagePassingQueue<E>
,QueueProgressIndicators
Differently from
MpscUnboundedArrayQueue
it is designed to provide a better scaling when more
producers are concurrently offering.Users should be aware that
poll()
could spin while awaiting a new element to be available:
to avoid this behaviour relaxedPoll()
should be used instead, accounting for the semantic differences
between the twos.-
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 inherited from class org.jctools.queues.MpUnboundedXaddArrayQueue
chunkMask, chunkShift, freeChunksPool, maxPooledChunks
Fields inherited from class org.jctools.queues.MpUnboundedXaddArrayQueuePad5
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, b073, b074, b075, b076, b077, b100, b101, b102, b103, b104, b105, b106, b107, b110, b111, b112, b113, b114, b115, b116, b117, b120, b121, b122, b123, b124, b125, b126, b127, b130, b131, b132, b133, b134, b135, b136, b137, b140, b141, b142, b143, b144, b145, b146, b147, b150, b151, b152, b153, b154, b155, b156, b157, b160, b161, b162, b163, b164, b165, b166, b167
Fields inherited from class org.jctools.queues.MpUnboundedXaddArrayQueuePad1
b170, b171, b172, b173, b174, b175, b176, b177
Fields inherited from interface org.jctools.queues.MessagePassingQueue
UNBOUNDED_CAPACITY
-
Constructor Summary
ConstructorsConstructorDescriptionMpscUnboundedXaddArrayQueue
(int chunkSize) MpscUnboundedXaddArrayQueue
(int chunkSize, int maxPooledChunks) -
Method Summary
Modifier and TypeMethodDescriptionint
drain
(MessagePassingQueue.Consumer<E> c, int limit) Remove up to limit elements from the queue and hand to consume.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.(package private) final MpscUnboundedXaddChunk
<E> newChunk
(long index, MpscUnboundedXaddChunk<E> prev, int chunkSize, boolean pooled) boolean
Called from a producer thread subject to the restrictions appropriate to the implementation and according to theQueue.offer(Object)
interface.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.private MpscUnboundedXaddChunk
<E> pollNextBuffer
(MpscUnboundedXaddChunk<E> cChunk, long cIndex) 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.private MpscUnboundedXaddChunk
<E> spinForNextIfNotEmpty
(MpscUnboundedXaddChunk<E> cChunk, long cIndex) Methods inherited from class org.jctools.queues.MpUnboundedXaddArrayQueue
appendNextChunks, capacity, chunkSize, currentConsumerIndex, currentProducerIndex, drain, drain, fill, isEmpty, iterator, maxPooledChunks, moveToNextConsumerChunk, producerChunkForIndex, relaxedOffer, size, toString
Methods inherited from class org.jctools.queues.MpUnboundedXaddArrayQueueConsumerFields
casConsumerIndex, lpConsumerChunk, lpConsumerIndex, lvConsumerChunk, lvConsumerIndex, soConsumerChunk, soConsumerIndex
Methods inherited from class org.jctools.queues.MpUnboundedXaddArrayQueueProducerChunk
casProducerChunkIndex, lvProducerChunk, lvProducerChunkIndex, soProducerChunk, soProducerChunkIndex
Methods inherited from class org.jctools.queues.MpUnboundedXaddArrayQueueProducerFields
getAndAddProducerIndex, getAndIncrementProducerIndex, lvProducerIndex
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.Collection
contains, containsAll, equals, hashCode, parallelStream, remove, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray, toArray
Methods inherited from interface org.jctools.queues.MessagePassingQueue
clear
-
Constructor Details
-
MpscUnboundedXaddArrayQueue
public MpscUnboundedXaddArrayQueue(int chunkSize, int maxPooledChunks) - Parameters:
chunkSize
- The buffer size to be used in each chunk of this queuemaxPooledChunks
- The maximum number of reused chunks kept around to avoid allocation, chunks are pre-allocated
-
MpscUnboundedXaddArrayQueue
public MpscUnboundedXaddArrayQueue(int chunkSize)
-
-
Method Details
-
newChunk
final MpscUnboundedXaddChunk<E> newChunk(long index, MpscUnboundedXaddChunk<E> prev, int chunkSize, boolean pooled) - Specified by:
newChunk
in classMpUnboundedXaddArrayQueue<MpscUnboundedXaddChunk<E>,
E>
-
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.- Parameters:
e
- notnull
, will throw NPE if it is- Returns:
- true if element was inserted into the queue, false iff full
-
pollNextBuffer
-
spinForNextIfNotEmpty
private MpscUnboundedXaddChunk<E> spinForNextIfNotEmpty(MpscUnboundedXaddChunk<E> cChunk, long cIndex) -
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
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
-
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
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
-
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>
- Overrides:
fill
in classMpUnboundedXaddArrayQueue<MpscUnboundedXaddChunk<E>,
E> - Returns:
- the number of offered 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>
- Overrides:
drain
in classMpUnboundedXaddArrayQueue<MpscUnboundedXaddChunk<E>,
E> - Returns:
- the number of polled elements
-
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.- Returns:
- the number of offered elements
-