Class MpUnboundedXaddArrayQueue<R extends MpUnboundedXaddChunk<R,E>,E>
- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- java.util.AbstractQueue<E>
-
- org.jctools.queues.MpUnboundedXaddArrayQueuePad1<E>
-
- org.jctools.queues.MpUnboundedXaddArrayQueueProducerFields<E>
-
- org.jctools.queues.MpUnboundedXaddArrayQueuePad2<E>
-
- org.jctools.queues.MpUnboundedXaddArrayQueueProducerChunk<R,E>
-
- org.jctools.queues.MpUnboundedXaddArrayQueuePad3<R,E>
-
- org.jctools.queues.MpUnboundedXaddArrayQueueConsumerFields<R,E>
-
- org.jctools.queues.MpUnboundedXaddArrayQueuePad5<R,E>
-
- org.jctools.queues.MpUnboundedXaddArrayQueue<R,E>
-
- All Implemented Interfaces:
java.lang.Iterable<E>
,java.util.Collection<E>
,java.util.Queue<E>
,IndexedQueueSizeUtil.IndexedQueue
,MessagePassingQueue<E>
,QueueProgressIndicators
- Direct Known Subclasses:
MpmcUnboundedXaddArrayQueue
,MpscUnboundedXaddArrayQueue
abstract class MpUnboundedXaddArrayQueue<R extends MpUnboundedXaddChunk<R,E>,E> extends MpUnboundedXaddArrayQueuePad5<R,E> implements MessagePassingQueue<E>, QueueProgressIndicators
Common infrastructure for the XADD queues.
-
-
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) int
chunkMask
(package private) int
chunkShift
(package private) SpscArrayQueue<R>
freeChunksPool
(package private) int
maxPooledChunks
private static long
ROTATION
-
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
Constructors Constructor Description MpUnboundedXaddArrayQueue(int chunkSize, int maxPooledChunks)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description private R
appendNextChunks(R currentChunk, long currentChunkIndex, long chunksToAppend)
int
capacity()
int
chunkSize()
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.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.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()
int
maxPooledChunks()
(package private) void
moveToNextConsumerChunk(R cChunk, R next)
Does not null out the first element of `next`, callers must do that(package private) abstract R
newChunk(long index, R prev, int chunkSize, boolean pooled)
private R
newOrPooledChunk(R prevChunk, long nextChunkIndex)
(package private) R
producerChunkForIndex(R initialChunk, long requiredChunkIndex)
We're here because currentChunk.index doesn't match the expectedChunkIndex.boolean
relaxedOffer(E e)
Called from a producer thread subject to the restrictions appropriate to the implementation.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.java.lang.String
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, fill, offer, peek, poll, relaxedPeek, relaxedPoll
-
-
-
-
Field Detail
-
ROTATION
private static final long ROTATION
- See Also:
- Constant Field Values
-
chunkMask
final int chunkMask
-
chunkShift
final int chunkShift
-
maxPooledChunks
final int maxPooledChunks
-
freeChunksPool
final SpscArrayQueue<R extends MpUnboundedXaddChunk<R,E>> freeChunksPool
-
-
Method Detail
-
chunkSize
public final int chunkSize()
-
maxPooledChunks
public final int maxPooledChunks()
-
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
-
producerChunkForIndex
final R producerChunkForIndex(R initialChunk, long requiredChunkIndex)
We're here because currentChunk.index doesn't match the expectedChunkIndex. To resolve we must now chase the linked chunks to the appropriate chunk. More than one producer may end up racing to add or discover new chunks.- Parameters:
initialChunk
- the starting point chunk, which does not match the required chunk indexrequiredChunkIndex
- the chunk index we need- Returns:
- the chunk matching the required index
-
appendNextChunks
private R appendNextChunks(R currentChunk, long currentChunkIndex, long chunksToAppend)
-
moveToNextConsumerChunk
final void moveToNextConsumerChunk(R cChunk, R next)
Does not null out the first element of `next`, callers must do that
-
iterator
public java.util.Iterator<E> iterator()
- Specified by:
iterator
in interfacejava.util.Collection<R extends MpUnboundedXaddChunk<R,E>>
- Specified by:
iterator
in interfacejava.lang.Iterable<R extends MpUnboundedXaddChunk<R,E>>
- Specified by:
iterator
in classjava.util.AbstractCollection<E>
-
size
public 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 interfacejava.util.Collection<R extends MpUnboundedXaddChunk<R,E>>
- Specified by:
size
in interfaceMessagePassingQueue<R extends MpUnboundedXaddChunk<R,E>>
- Specified by:
size
in classjava.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 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 interfacejava.util.Collection<R extends MpUnboundedXaddChunk<R,E>>
- Specified by:
isEmpty
in interfaceMessagePassingQueue<R extends MpUnboundedXaddChunk<R,E>>
- Overrides:
isEmpty
in classjava.util.AbstractCollection<E>
- Returns:
- true if empty, false otherwise
-
capacity
public int capacity()
- Specified by:
capacity
in interfaceIndexedQueueSizeUtil.IndexedQueue
- Specified by:
capacity
in interfaceMessagePassingQueue<R extends MpUnboundedXaddChunk<R,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 toQueue.offer(Object)
this method may return false without the queue being full.- Specified by:
relaxedOffer
in interfaceMessagePassingQueue<R extends MpUnboundedXaddChunk<R,E>>
- Parameters:
e
- notnull
, will throw NPE if it is- Returns:
- true if element was inserted into the queue, false if unable to offer
-
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 interfaceMessagePassingQueue<R extends MpUnboundedXaddChunk<R,E>>
- 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.- Specified by:
fill
in interfaceMessagePassingQueue<R extends MpUnboundedXaddChunk<R,E>>
- 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.- Specified by:
drain
in interfaceMessagePassingQueue<R extends MpUnboundedXaddChunk<R,E>>
- Returns:
- the number of polled 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.- Specified by:
drain
in interfaceMessagePassingQueue<R extends MpUnboundedXaddChunk<R,E>>
-
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<R extends MpUnboundedXaddChunk<R,E>>
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.util.AbstractCollection<E>
-
-