org.jctools.queues.atomic

Class MpscGrowableAtomicArrayQueue<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

org.jctools.queues.atomic.BaseMpscLinkedAtomicArrayQueue<E>

org.jctools.queues.atomic.MpscChunkedAtomicArrayQueue<E>

org.jctools.queues.atomic.MpscGrowableAtomicArrayQueue<E>

Type Parameters:

E -

All Implemented Interfaces:

Iterable<E>, Collection<E>, Queue<E>, MessagePassingQueue<E>, QueueProgressIndicators

public class MpscGrowableAtomicArrayQueue<E>
extends MpscChunkedAtomicArrayQueue<E>
implements MessagePassingQueue<E>, QueueProgressIndicators

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 and Description
protected AtomicReferenceArray<E>	consumerBuffer
protected AtomicLong	consumerIndex
protected long	consumerMask
protected long	maxQueueCapacity
protected AtomicReferenceArray<E>	producerBuffer
protected AtomicLong	producerIndex
protected AtomicLong	producerLimit
protected long	producerMask

Fields inherited from interface org.jctools.queues.MessagePassingQueue

UNBOUNDED_CAPACITY

Constructor Summary

Constructors

Constructor and Description
MpscGrowableAtomicArrayQueue(int maxCapacity)
MpscGrowableAtomicArrayQueue(int initialCapacity, int maxCapacity)

Method Summary

Modifier and Type	Method and Description
protected long	getCurrentBufferCapacity(long mask)
protected int	getNextBufferSize(AtomicReferenceArray<E> buffer)

Methods inherited from class org.jctools.queues.atomic.MpscChunkedAtomicArrayQueue

availableInQueue, capacity

Methods inherited from class org.jctools.queues.atomic.BaseMpscLinkedAtomicArrayQueue

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

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 org.jctools.queues.MessagePassingQueue

capacity, clear, drain, drain, drain, fill, fill, fill, isEmpty, offer, peek, poll, relaxedOffer, relaxedPeek, relaxedPoll, size

Methods inherited from interface org.jctools.queues.QueueProgressIndicators

currentConsumerIndex, currentProducerIndex

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

Field Detail

maxQueueCapacity

protected final long maxQueueCapacity

producerLimit

protected volatile AtomicLong producerLimit

producerMask

protected long producerMask

producerBuffer

protected AtomicReferenceArray<E> producerBuffer

consumerMask

protected long consumerMask

consumerBuffer

protected AtomicReferenceArray<E> consumerBuffer

consumerIndex

protected AtomicLong consumerIndex

producerIndex

protected AtomicLong producerIndex

Constructor Detail

MpscGrowableAtomicArrayQueue

public MpscGrowableAtomicArrayQueue(int maxCapacity)

MpscGrowableAtomicArrayQueue

public MpscGrowableAtomicArrayQueue(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(AtomicReferenceArray<E> buffer)

Overrides:

getNextBufferSize in class MpscChunkedAtomicArrayQueue<E>

Returns:

next buffer size(inclusive of next array pointer)

getCurrentBufferCapacity

protected long getCurrentBufferCapacity(long mask)

Overrides:

getCurrentBufferCapacity in class MpscChunkedAtomicArrayQueue<E>

Returns:

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