org.jctools.queues.atomic

Class MpscUnboundedAtomicArrayQueue<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

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

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

Type Parameters:

E -

All Implemented Interfaces:

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

public class MpscUnboundedAtomicArrayQueue<E>
extends BaseMpscLinkedAtomicArrayQueue<E>

NOTE: This class was automatically generated by org.jctools.queues.atomic.JavaParsingAtomicLinkedQueueGenerator which can found in the jctools-build module. The original source file is MpscUnboundedArrayQueue.java. An MPSC array queue which starts at initialCapacity and grows indefinitely 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 AtomicReferenceArray<E>	consumerBuffer
protected long	consumerIndex
protected long	consumerMask
protected AtomicReferenceArray<E>	producerBuffer
protected long	producerIndex
protected long	producerMask

Fields inherited from interface org.jctools.queues.MessagePassingQueue

UNBOUNDED_CAPACITY

Constructor Summary

Constructors

Constructor and Description
MpscUnboundedAtomicArrayQueue(int chunkSize)

Method Summary

Modifier and Type	Method and Description
protected long	availableInQueue(long pIndex, long cIndex)
int	capacity()
int	drain(MessagePassingQueue.Consumer<E> c) Remove all available item from the queue and hand to consume.
int	fill(MessagePassingQueue.Supplier<E> s) Stuff the queue with elements from the supplier.
protected long	getCurrentBufferCapacity(long mask)
protected int	getNextBufferSize(AtomicReferenceArray<E> buffer)
long	lvConsumerIndex()
long	lvProducerIndex()

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

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

producerMask

protected long producerMask

producerBuffer

protected AtomicReferenceArray<E> producerBuffer

consumerMask

protected long consumerMask

consumerBuffer

protected AtomicReferenceArray<E> consumerBuffer

consumerIndex

protected volatile long consumerIndex

producerIndex

protected volatile long producerIndex

Constructor Detail

MpscUnboundedAtomicArrayQueue

public MpscUnboundedAtomicArrayQueue(int chunkSize)

Method Detail

availableInQueue

protected long availableInQueue(long pIndex,
                                long cIndex)

Specified by:

availableInQueue in class BaseMpscLinkedAtomicArrayQueue<E>

Returns:

available elements in queue * 2

capacity

public int capacity()

Specified by:

capacity in interface MessagePassingQueue<E>

Specified by:

capacity in class BaseMpscLinkedAtomicArrayQueue<E>

Returns:

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

drain

public int drain(MessagePassingQueue.Consumer<E> c)

Description copied from interface: MessagePassingQueue

Remove all available item from the queue and hand to consume. This should be semantically similar to:
M m;
while((m = relaxedPoll()) != null){
c.accept(m);
}
There's no strong commitment to the queue being empty at the end of a drain. Called from a consumer thread subject to the restrictions appropriate to the implementation.

Specified by:

drain in interface MessagePassingQueue<E>

Overrides:

drain in class BaseMpscLinkedAtomicArrayQueue<E>

Returns:

the number of polled elements

fill

public int fill(MessagePassingQueue.Supplier<E> s)

Description copied from interface: MessagePassingQueue

Stuff the queue with elements from the supplier. Semantically similar to:
while(relaxedOffer(s.get());
There's no strong commitment to the queue being full at the end of a fill. Called from a producer thread subject to the restrictions appropriate to the implementation.

Specified by:

fill in interface MessagePassingQueue<E>

Overrides:

fill in class BaseMpscLinkedAtomicArrayQueue<E>

Returns:

the number of offered elements

getNextBufferSize

protected int getNextBufferSize(AtomicReferenceArray<E> buffer)

Specified by:

getNextBufferSize in class BaseMpscLinkedAtomicArrayQueue<E>

Returns:

next buffer size(inclusive of next array pointer)

getCurrentBufferCapacity

protected long getCurrentBufferCapacity(long mask)

Specified by:

getCurrentBufferCapacity in class BaseMpscLinkedAtomicArrayQueue<E>

Returns:

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

lvConsumerIndex

public final long lvConsumerIndex()

lvProducerIndex

public final long lvProducerIndex()