Class MpscChunkedAtomicUnpaddedArrayQueue<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

org.jctools.queues.atomic.unpadded.BaseMpscLinkedAtomicUnpaddedArrayQueuePad1<E>

org.jctools.queues.atomic.unpadded.BaseMpscLinkedAtomicUnpaddedArrayQueueProducerFields<E>

org.jctools.queues.atomic.unpadded.BaseMpscLinkedAtomicUnpaddedArrayQueuePad2<E>

org.jctools.queues.atomic.unpadded.BaseMpscLinkedAtomicUnpaddedArrayQueueConsumerFields<E>

org.jctools.queues.atomic.unpadded.BaseMpscLinkedAtomicUnpaddedArrayQueuePad3<E>

org.jctools.queues.atomic.unpadded.BaseMpscLinkedAtomicUnpaddedArrayQueueColdProducerFields<E>

org.jctools.queues.atomic.unpadded.BaseMpscLinkedAtomicUnpaddedArrayQueue<E>

org.jctools.queues.atomic.unpadded.MpscChunkedAtomicUnpaddedArrayQueueColdProducerFields<E>

org.jctools.queues.atomic.unpadded.MpscChunkedAtomicUnpaddedArrayQueue<E>

All Implemented Interfaces:

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

Direct Known Subclasses:

MpscGrowableAtomicUnpaddedArrayQueue

public class MpscChunkedAtomicUnpaddedArrayQueue<E>
extends MpscChunkedAtomicUnpaddedArrayQueueColdProducerFields<E>

NOTE: This class was automatically generated by org.jctools.queues.atomic.unpadded.JavaParsingAtomicUnpaddedLinkedQueueGenerator which can found in the jctools-build module. The original source file is MpscChunkedArrayQueue.java. 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 MessagePassingQueue

MessagePassingQueue.Consumer<T>, MessagePassingQueue.ExitCondition, MessagePassingQueue.Supplier<T>, MessagePassingQueue.WaitStrategy

Field Summary

Fields inherited from class MpscChunkedAtomicUnpaddedArrayQueueColdProducerFields

maxQueueCapacity

Fields inherited from class BaseMpscLinkedAtomicUnpaddedArrayQueueColdProducerFields

producerBuffer, producerMask

Fields inherited from class BaseMpscLinkedAtomicUnpaddedArrayQueueConsumerFields

consumerBuffer, consumerMask

Fields inherited from interface MessagePassingQueue

UNBOUNDED_CAPACITY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected long	availableInQueue(long pIndex, long cIndex)
int	capacity()
protected long	getCurrentBufferCapacity(long mask)
protected int	getNextBufferSize(AtomicReferenceArray<E> buffer)

Methods inherited from class BaseMpscLinkedAtomicUnpaddedArrayQueue

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

Methods inherited from class BaseMpscLinkedAtomicUnpaddedArrayQueueColdProducerFields

casProducerLimit, lvProducerLimit, soProducerLimit

Methods inherited from class BaseMpscLinkedAtomicUnpaddedArrayQueueConsumerFields

lpConsumerIndex, lvConsumerIndex, soConsumerIndex

Methods inherited from class BaseMpscLinkedAtomicUnpaddedArrayQueueProducerFields

casProducerIndex, lvProducerIndex, soProducerIndex

Methods inherited from class AbstractQueue

add, addAll, clear, element, remove

Methods inherited from class AbstractCollection

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

Methods inherited from class Object

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

Methods inherited from interface Collection

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

Methods inherited from interface Iterable

forEach

Methods inherited from interface MessagePassingQueue

clear

Constructor Details

MpscChunkedAtomicUnpaddedArrayQueue

public MpscChunkedAtomicUnpaddedArrayQueue(int maxCapacity)

MpscChunkedAtomicUnpaddedArrayQueue

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

availableInQueue

protected long availableInQueue(long pIndex,
 long cIndex)

Specified by:

availableInQueue in class BaseMpscLinkedAtomicUnpaddedArrayQueue<E>

Returns:

available elements in queue * 2

capacity

public int capacity()

Specified by:

capacity in interface IndexedQueueSizeUtil.IndexedQueue

Specified by:

capacity in interface MessagePassingQueue<E>

Specified by:

capacity in class BaseMpscLinkedAtomicUnpaddedArrayQueue<E>

Returns:

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

getNextBufferSize

protected int getNextBufferSize(AtomicReferenceArray<E> buffer)

Specified by:

getNextBufferSize in class BaseMpscLinkedAtomicUnpaddedArrayQueue<E>

Returns:

next buffer size(inclusive of next array pointer)

getCurrentBufferCapacity

protected long getCurrentBufferCapacity(long mask)

Specified by:

getCurrentBufferCapacity in class BaseMpscLinkedAtomicUnpaddedArrayQueue<E>

Returns:

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