org.jctools.queues

Class MpscChunkedArrayQueue<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

org.jctools.queues.BaseMpscLinkedArrayQueue<E>

org.jctools.queues.MpscChunkedArrayQueue<E>

Type Parameters:

E -

All Implemented Interfaces:

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

Direct Known Subclasses:

MpscGrowableArrayQueue

public class MpscChunkedArrayQueue<E>
extends BaseMpscLinkedArrayQueue<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 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

Modifier and Type	Field and 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 and Description
MpscChunkedArrayQueue(int maxCapacity)
MpscChunkedArrayQueue(int initialCapacity, int maxCapacity)

Method Summary

Modifier and Type	Method and Description
protected long	availableInQueue(long pIndex, long cIndex)
int	capacity()
protected long	getCurrentBufferCapacity(long mask)
protected int	getNextBufferSize(E[] buffer)
long	lvConsumerIndex()
long	lvProducerIndex()

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 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

clear

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

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

MpscChunkedArrayQueue

public MpscChunkedArrayQueue(int maxCapacity)

MpscChunkedArrayQueue

public MpscChunkedArrayQueue(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

availableInQueue

protected long availableInQueue(long pIndex,
                                long cIndex)

Specified by:

availableInQueue in class BaseMpscLinkedArrayQueue<E>

Returns:

available elements in queue * 2

capacity

public int capacity()

Specified by:

capacity in interface MessagePassingQueue<E>

Specified by:

capacity in class BaseMpscLinkedArrayQueue<E>

Returns:

the capacity of this queue or MessagePassingQueue.UNBOUNDED_CAPACITY if not bounded

getNextBufferSize

protected int getNextBufferSize(E[] buffer)

Specified by:

getNextBufferSize in class BaseMpscLinkedArrayQueue<E>

Returns:

next buffer size(inclusive of next array pointer)

getCurrentBufferCapacity

protected long getCurrentBufferCapacity(long mask)

Specified by:

getCurrentBufferCapacity in class BaseMpscLinkedArrayQueue<E>

Returns:

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

lvConsumerIndex

public final long lvConsumerIndex()

lvProducerIndex

public final long lvProducerIndex()