Package org.jctools.queues

Class MpscGrowableArrayQueue<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

org.jctools.queues.BaseMpscLinkedArrayQueue<E>

org.jctools.queues.MpscChunkedArrayQueue<E>

org.jctools.queues.MpscGrowableArrayQueue<E>

Type Parameters:

E -

All Implemented Interfaces:

IndexedQueueSizeUtil.IndexedQueue, MessagePassingQueue<E>, QueueProgressIndicators

public class MpscGrowableArrayQueue<E>
extends MpscChunkedArrayQueue<E>

An MPSC array queue which starts at initialCapacity and grows to maxCapacity in linked chunks of the initial size. The queue grows only when the current buffer is full and elements are not copied on resize, instead a link to the new buffer is stored in the old buffer 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

Modifier and Type	Field	Description
protected E[]	consumerBuffer
protected long	consumerIndex
protected long	consumerMask
protected long	maxQueueCapacity
protected E[]	producerBuffer
protected long	producerIndex
protected long	producerMask

Fields inherited from interface org.jctools.queues.MessagePassingQueue

UNBOUNDED_CAPACITY

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.util.AbstractCollection

contains, containsAll, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.util.AbstractQueue

add, addAll, clear, element, remove

Methods inherited from class org.jctools.queues.BaseMpscLinkedArrayQueue

currentConsumerIndex, currentProducerIndex, drain, drain, drain, fill, fill, fill, isEmpty, iterator, offer, peek, poll, relaxedOffer, relaxedPeek, relaxedPoll, size, toString

Methods inherited from interface java.util.Collection

contains, containsAll, equals, hashCode, parallelStream, remove, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface org.jctools.queues.MessagePassingQueue

clear

Methods inherited from class org.jctools.queues.MpscChunkedArrayQueue

availableInQueue, capacity

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

maxQueueCapacity

protected final long maxQueueCapacity

producerMask

protected long producerMask

producerBuffer

protected E[] producerBuffer

consumerMask

protected long consumerMask

consumerBuffer

protected E[] consumerBuffer

consumerIndex

protected long consumerIndex

producerIndex

protected long producerIndex

Constructor Detail

MpscGrowableArrayQueue

public MpscGrowableArrayQueue(int maxCapacity)

MpscGrowableArrayQueue

public MpscGrowableArrayQueue(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 Detail

getNextBufferSize

protected int getNextBufferSize(E[] buffer)

Overrides:

getNextBufferSize in class MpscChunkedArrayQueue<E>

Returns:

next buffer size(inclusive of next array pointer)

getCurrentBufferCapacity

protected long getCurrentBufferCapacity(long mask)

Overrides:

getCurrentBufferCapacity in class MpscChunkedArrayQueue<E>

Returns:

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

lvConsumerIndex

public final long lvConsumerIndex()

lvProducerIndex

public final long lvProducerIndex()