Package org.jctools.queues.unpadded
Class MpscUnboundedUnpaddedArrayQueue<E>
java.lang.Object
java.util.AbstractCollection<E>
java.util.AbstractQueue<E>
org.jctools.queues.unpadded.BaseMpscLinkedUnpaddedArrayQueuePad1<E>
org.jctools.queues.unpadded.BaseMpscLinkedUnpaddedArrayQueueProducerFields<E>
org.jctools.queues.unpadded.BaseMpscLinkedUnpaddedArrayQueuePad2<E>
org.jctools.queues.unpadded.BaseMpscLinkedUnpaddedArrayQueueConsumerFields<E>
org.jctools.queues.unpadded.BaseMpscLinkedUnpaddedArrayQueuePad3<E>
org.jctools.queues.unpadded.BaseMpscLinkedUnpaddedArrayQueueColdProducerFields<E>
org.jctools.queues.unpadded.BaseMpscLinkedUnpaddedArrayQueue<E>
org.jctools.queues.unpadded.MpscUnboundedUnpaddedArrayQueue<E>
- All Implemented Interfaces:
Iterable<E>
,Collection<E>
,Queue<E>
,IndexedQueueSizeUtil.IndexedQueue
,MessagePassingQueue<E>
,QueueProgressIndicators
NOTE: This class was automatically generated by org.jctools.queues.unpadded.JavaParsingUnpaddedQueueGenerator
which can found in the jctools-build module. The original source file is MpscUnboundedArrayQueue.java.
An MPSC array queue which starts at initialCapacity and grows indefinitely in linked chunks of the initial size.
The queue grows only when the current chunk is full and elements are not copied on
resize, instead a link to the new chunk is stored in the old chunk for the consumer to follow.
-
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.unpadded.BaseMpscLinkedUnpaddedArrayQueueColdProducerFields
producerBuffer, producerMask
Fields inherited from class org.jctools.queues.unpadded.BaseMpscLinkedUnpaddedArrayQueueConsumerFields
consumerBuffer, consumerMask
Fields inherited from interface org.jctools.queues.MessagePassingQueue
UNBOUNDED_CAPACITY
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected long
availableInQueue
(long pIndex, long cIndex) int
capacity()
int
Remove all available item from the queue and hand to consume.int
Stuff the queue with elements from the supplier.protected long
getCurrentBufferCapacity
(long mask) protected int
getNextBufferSize
(E[] buffer) Methods inherited from class org.jctools.queues.unpadded.BaseMpscLinkedUnpaddedArrayQueue
currentConsumerIndex, currentProducerIndex, drain, drain, fill, fill, isEmpty, iterator, offer, peek, poll, relaxedOffer, relaxedPeek, relaxedPoll, size, toString
Methods inherited from class org.jctools.queues.unpadded.BaseMpscLinkedUnpaddedArrayQueueColdProducerFields
casProducerLimit, lvProducerLimit, soProducerLimit
Methods inherited from class org.jctools.queues.unpadded.BaseMpscLinkedUnpaddedArrayQueueConsumerFields
lpConsumerIndex, lvConsumerIndex, soConsumerIndex
Methods inherited from class org.jctools.queues.unpadded.BaseMpscLinkedUnpaddedArrayQueueProducerFields
casProducerIndex, lvProducerIndex, soProducerIndex
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
-
MpscUnboundedUnpaddedArrayQueue
public MpscUnboundedUnpaddedArrayQueue(int chunkSize)
-
-
Method Details
-
availableInQueue
protected long availableInQueue(long pIndex, long cIndex) - Specified by:
availableInQueue
in classBaseMpscLinkedUnpaddedArrayQueue<E>
- Returns:
- available elements in queue * 2
-
capacity
public int capacity()- Specified by:
capacity
in interfaceIndexedQueueSizeUtil.IndexedQueue
- Specified by:
capacity
in interfaceMessagePassingQueue<E>
- Specified by:
capacity
in classBaseMpscLinkedUnpaddedArrayQueue<E>
- Returns:
- the capacity of this queue or
MessagePassingQueue.UNBOUNDED_CAPACITY
if not bounded
-
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>
- Overrides:
drain
in classBaseMpscLinkedUnpaddedArrayQueue<E>
- Returns:
- the number of polled elements
-
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 classBaseMpscLinkedUnpaddedArrayQueue<E>
- Returns:
- the number of offered elements
-
getNextBufferSize
- Specified by:
getNextBufferSize
in classBaseMpscLinkedUnpaddedArrayQueue<E>
- Returns:
- next buffer size(inclusive of next array pointer)
-
getCurrentBufferCapacity
protected long getCurrentBufferCapacity(long mask) - Specified by:
getCurrentBufferCapacity
in classBaseMpscLinkedUnpaddedArrayQueue<E>
- Returns:
- current buffer capacity for elements (excluding next pointer and jump entry) * 2
-