org.jctools.queues.atomic

Class SpscUnboundedAtomicArrayQueue<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

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

All Implemented Interfaces:

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

public class SpscUnboundedAtomicArrayQueue<E>
extends AbstractQueue<E>
implements QueueProgressIndicators

Field Summary

Fields

Modifier and Type	Field and Description
protected AtomicReferenceArray<Object>	consumerBuffer
protected AtomicLong	consumerIndex
protected int	consumerMask
protected AtomicReferenceArray<Object>	producerBuffer
protected AtomicLong	producerIndex
protected long	producerLookAhead
protected int	producerLookAheadStep
protected int	producerMask

Constructor Summary

Constructors

Constructor and Description
SpscUnboundedAtomicArrayQueue(int chunkSize)

Method Summary

Modifier and Type	Method and Description
long	currentConsumerIndex() This method has no concurrent visibility semantics.
long	currentProducerIndex() This method has no concurrent visibility semantics.
Iterator<E>	iterator()
boolean	offer(E e)
E	peek()
E	poll()
int	size()

Methods inherited from class java.util.AbstractQueue

add, addAll, clear, element, remove

Methods inherited from class java.util.AbstractCollection

contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

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

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

producerIndex

protected final AtomicLong producerIndex

producerLookAheadStep

protected int producerLookAheadStep

producerLookAhead

protected long producerLookAhead

producerMask

protected int producerMask

producerBuffer

protected AtomicReferenceArray<Object> producerBuffer

consumerMask

protected int consumerMask

consumerBuffer

protected AtomicReferenceArray<Object> consumerBuffer

consumerIndex

protected final AtomicLong consumerIndex

Constructor Detail

SpscUnboundedAtomicArrayQueue

public SpscUnboundedAtomicArrayQueue(int chunkSize)

Method Detail

iterator

public final Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in class AbstractCollection<E>

offer

public final boolean offer(E e)

This implementation is correct for single producer thread use only.

Specified by:

offer in interface Queue<E>

poll

public final E poll()

This implementation is correct for single consumer thread use only.

Specified by:

poll in interface Queue<E>

peek

public final E peek()

This implementation is correct for single consumer thread use only.

Specified by:

peek in interface Queue<E>

size

public final int size()

Specified by:

size in interface Collection<E>

Specified by:

size in class AbstractCollection<E>

currentProducerIndex

public long currentProducerIndex()

Description copied from interface: QueueProgressIndicators

This method has no concurrent visibility semantics. The value returned may be negative. Under normal circumstances 2 consecutive calls to this method can offer an idea of progress made by producer threads by subtracting the 2 results though in extreme cases (if producers have progressed by more than 2^64) this may also fail.
This value will normally indicate number of elements passed into the queue, but may under some circumstances be a derivative of that figure. This method should not be used to derive size or emptiness.

Specified by:

currentProducerIndex in interface QueueProgressIndicators

Returns:

the current value of the producer progress index

currentConsumerIndex

public long currentConsumerIndex()

Description copied from interface: QueueProgressIndicators

This method has no concurrent visibility semantics. The value returned may be negative. Under normal circumstances 2 consecutive calls to this method can offer an idea of progress made by consumer threads by subtracting the 2 results though in extreme cases (if consumers have progressed by more than 2^64) this may also fail.
This value will normally indicate number of elements taken out of the queue, but may under some circumstances be a derivative of that figure. This method should not be used to derive size or emptiness.

Specified by:

currentConsumerIndex in interface QueueProgressIndicators

Returns:

the current value of the consumer progress index