Package org.jctools.queues.unpadded

Class MpscGrowableUnpaddedArrayQueue<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.MpscChunkedUnpaddedArrayQueueColdProducerFields<E>

org.jctools.queues.unpadded.MpscChunkedUnpaddedArrayQueue<E>

org.jctools.queues.unpadded.MpscGrowableUnpaddedArrayQueue<E>

All Implemented Interfaces:

Iterable<E>, Collection<E>, Queue<E>, IndexedQueueSizeUtil.IndexedQueue, MessagePassingQueue<E>, QueueProgressIndicators

public class MpscGrowableUnpaddedArrayQueue<E>
extends MpscChunkedUnpaddedArrayQueue<E>

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 MpscGrowableArrayQueue.java. An MPSC array queue which starts at initialCapacity and grows to maxCapacity in linked chunks, doubling theirs size every time until the full blown backing array is used. 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.MpscChunkedUnpaddedArrayQueueColdProducerFields

maxQueueCapacity

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

Constructor	Description
MpscGrowableUnpaddedArrayQueue(int maxCapacity)
MpscGrowableUnpaddedArrayQueue(int initialCapacity, int maxCapacity)

Method Summary

Modifier and Type	Method	Description
protected long	getCurrentBufferCapacity(long mask)
protected int	getNextBufferSize(E[] buffer)

Methods inherited from class org.jctools.queues.unpadded.MpscChunkedUnpaddedArrayQueue

availableInQueue, capacity

Methods inherited from class org.jctools.queues.unpadded.BaseMpscLinkedUnpaddedArrayQueue

currentConsumerIndex, currentProducerIndex, drain, drain, drain, fill, 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.AbstractQueue

add, addAll, clear, element, remove

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 java.lang.Iterable

forEach

Methods inherited from interface org.jctools.queues.MessagePassingQueue

clear

Constructor Details

MpscGrowableUnpaddedArrayQueue

public MpscGrowableUnpaddedArrayQueue(int maxCapacity)

MpscGrowableUnpaddedArrayQueue

public MpscGrowableUnpaddedArrayQueue(int initialCapacity,
 int maxCapacity)

Parameters:

initialCapacity - the queue initial capacity. If chunk size is fixed this will be the chunk size. Must be 2 or more.

maxCapacity - the maximum capacity will be rounded up to the closest power of 2 and will be the upper limit of number of elements in this queue. Must be 4 or more and round up to a larger power of 2 than initialCapacity.

Method Details

getNextBufferSize

protected int getNextBufferSize(E[] buffer)

Overrides:

getNextBufferSize in class MpscChunkedUnpaddedArrayQueue<E>

Returns:

next buffer size(inclusive of next array pointer)

getCurrentBufferCapacity

protected long getCurrentBufferCapacity(long mask)

Overrides:

getCurrentBufferCapacity in class MpscChunkedUnpaddedArrayQueue<E>

Returns:

current buffer capacity for elements (excluding next pointer and jump entry) * 2