org.jctools.queues.atomic

Class BaseSpscLinkedAtomicArrayQueue<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

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

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

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

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

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

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

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

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, java.util.Queue<E>, IndexedQueueSizeUtil.IndexedQueue, QueueProgressIndicators

Direct Known Subclasses:

SpscChunkedAtomicArrayQueue, SpscGrowableAtomicArrayQueue, SpscUnboundedAtomicArrayQueue

abstract class BaseSpscLinkedAtomicArrayQueue<E>
extends BaseSpscLinkedAtomicArrayQueueProducerColdFields<E>
implements QueueProgressIndicators, IndexedQueueSizeUtil.IndexedQueue

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.Object	JUMP

Fields inherited from class org.jctools.queues.atomic.BaseSpscLinkedAtomicArrayQueueProducerColdFields

producerBuffer, producerBufferLimit, producerMask

Fields inherited from class org.jctools.queues.atomic.BaseSpscLinkedAtomicArrayQueueProducerFields

P_INDEX_UPDATER, producerIndex

Fields inherited from class org.jctools.queues.atomic.BaseSpscLinkedAtomicArrayQueueL2Pad

p0, p1, p10, p11, p12, p13, p14, p15, p16, p17, p2, p3, p4, p5, p6, p7

Fields inherited from class org.jctools.queues.atomic.BaseSpscLinkedAtomicArrayQueueConsumerField

C_INDEX_UPDATER, consumerIndex

Fields inherited from class org.jctools.queues.atomic.BaseSpscLinkedAtomicArrayQueueConsumerColdFields

consumerBuffer, consumerMask

Constructor Summary

Constructors

Constructor and Description
BaseSpscLinkedAtomicArrayQueue()

Method Summary

Modifier and Type	Method and Description
protected static <E> java.util.concurrent.atomic.AtomicReferenceArray<E>	allocate(int capacity)
protected static int	calcElementOffset(long index, long mask)
long	currentConsumerIndex() This method has no concurrent visibility semantics.
long	currentProducerIndex() This method has no concurrent visibility semantics.
boolean	isEmpty()
java.util.Iterator<E>	iterator()
protected void	linkOldToNew(long currIndex, java.util.concurrent.atomic.AtomicReferenceArray<E> oldBuffer, int offset, java.util.concurrent.atomic.AtomicReferenceArray<E> newBuffer, int offsetInNew, E e)
long	lvConsumerIndex()
protected E	lvElement(java.util.concurrent.atomic.AtomicReferenceArray<E> buffer, int offset)
protected java.util.concurrent.atomic.AtomicReferenceArray<E>	lvNextArrayAndUnlink(java.util.concurrent.atomic.AtomicReferenceArray curr)
long	lvProducerIndex()
private E	newBufferPeek(java.util.concurrent.atomic.AtomicReferenceArray<E> buffer, long index)
private E	newBufferPoll(java.util.concurrent.atomic.AtomicReferenceArray<E> buffer, long index)
private int	nextArrayOffset(java.util.concurrent.atomic.AtomicReferenceArray<E> curr)
boolean	offer(E e)
protected abstract boolean	offerColdPath(java.util.concurrent.atomic.AtomicReferenceArray<E> buffer, long mask, E e, long pIndex, int offset)
E	peek()
E	poll()
int	size()
protected void	soConsumerIndex(long v)
private void	soElement(java.util.concurrent.atomic.AtomicReferenceArray curr, int i, java.lang.Object e)
protected void	soNext(java.util.concurrent.atomic.AtomicReferenceArray<E> curr, java.util.concurrent.atomic.AtomicReferenceArray<E> next)
protected void	soProducerIndex(long v)
java.lang.String	toString()
protected void	writeToQueue(java.util.concurrent.atomic.AtomicReferenceArray<E> buffer, E e, long index, int offset)

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

JUMP

protected static final java.lang.Object JUMP

Constructor Detail

BaseSpscLinkedAtomicArrayQueue

BaseSpscLinkedAtomicArrayQueue()

Method Detail

soProducerIndex

protected final void soProducerIndex(long v)

soConsumerIndex

protected final void soConsumerIndex(long v)

lvProducerIndex

public final long lvProducerIndex()

Specified by:

lvProducerIndex in interface IndexedQueueSizeUtil.IndexedQueue

lvConsumerIndex

public final long lvConsumerIndex()

Specified by:

lvConsumerIndex in interface IndexedQueueSizeUtil.IndexedQueue

allocate

protected static <E> java.util.concurrent.atomic.AtomicReferenceArray<E> allocate(int capacity)

iterator

public final java.util.Iterator<E> iterator()

Specified by:

iterator in interface java.lang.Iterable<E>

Specified by:

iterator in interface java.util.Collection<E>

Specified by:

iterator in class java.util.AbstractCollection<E>

toString

public java.lang.String toString()

Overrides:

toString in class java.util.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

soNext

protected final void soNext(java.util.concurrent.atomic.AtomicReferenceArray<E> curr,
                            java.util.concurrent.atomic.AtomicReferenceArray<E> next)

soElement

private void soElement(java.util.concurrent.atomic.AtomicReferenceArray curr,
                       int i,
                       java.lang.Object e)

lvNextArrayAndUnlink

protected final java.util.concurrent.atomic.AtomicReferenceArray<E> lvNextArrayAndUnlink(java.util.concurrent.atomic.AtomicReferenceArray curr)

nextArrayOffset

private int nextArrayOffset(java.util.concurrent.atomic.AtomicReferenceArray<E> curr)

offer

public boolean offer(E e)

This implementation is correct for single producer thread use only.

Specified by:

offer in interface java.util.Queue<E>

offerColdPath

protected abstract boolean offerColdPath(java.util.concurrent.atomic.AtomicReferenceArray<E> buffer,
                                         long mask,
                                         E e,
                                         long pIndex,
                                         int offset)

linkOldToNew

protected final void linkOldToNew(long currIndex,
                                  java.util.concurrent.atomic.AtomicReferenceArray<E> oldBuffer,
                                  int offset,
                                  java.util.concurrent.atomic.AtomicReferenceArray<E> newBuffer,
                                  int offsetInNew,
                                  E e)

writeToQueue

protected final void writeToQueue(java.util.concurrent.atomic.AtomicReferenceArray<E> buffer,
                                  E e,
                                  long index,
                                  int offset)

poll

public E poll()

This implementation is correct for single consumer thread use only.

Specified by:

poll in interface java.util.Queue<E>

lvElement

protected E lvElement(java.util.concurrent.atomic.AtomicReferenceArray<E> buffer,
                      int offset)

calcElementOffset

protected static int calcElementOffset(long index,
                                       long mask)

peek

public E peek()

This implementation is correct for single consumer thread use only.

Specified by:

peek in interface java.util.Queue<E>

newBufferPeek

private E newBufferPeek(java.util.concurrent.atomic.AtomicReferenceArray<E> buffer,
                        long index)

newBufferPoll

private E newBufferPoll(java.util.concurrent.atomic.AtomicReferenceArray<E> buffer,
                        long index)

size

public final int size()

Specified by:

size in interface java.util.Collection<E>

Specified by:

size in class java.util.AbstractCollection<E>

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<E>

Overrides:

isEmpty in class java.util.AbstractCollection<E>