Class BaseSpscLinkedAtomicUnpaddedArrayQueue<E>
- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- java.util.AbstractQueue<E>
-
- org.jctools.queues.atomic.unpadded.BaseSpscLinkedAtomicUnpaddedArrayQueuePrePad<E>
-
- org.jctools.queues.atomic.unpadded.BaseSpscLinkedAtomicUnpaddedArrayQueueConsumerColdFields<E>
-
- org.jctools.queues.atomic.unpadded.BaseSpscLinkedAtomicUnpaddedArrayQueueConsumerField<E>
-
- org.jctools.queues.atomic.unpadded.BaseSpscLinkedAtomicUnpaddedArrayQueueL2Pad<E>
-
- org.jctools.queues.atomic.unpadded.BaseSpscLinkedAtomicUnpaddedArrayQueueProducerFields<E>
-
- org.jctools.queues.atomic.unpadded.BaseSpscLinkedAtomicUnpaddedArrayQueueProducerColdFields<E>
-
- org.jctools.queues.atomic.unpadded.BaseSpscLinkedAtomicUnpaddedArrayQueue<E>
-
- All Implemented Interfaces:
java.lang.Iterable<E>
,java.util.Collection<E>
,java.util.Queue<E>
,IndexedQueueSizeUtil.IndexedQueue
,MessagePassingQueue<E>
,QueueProgressIndicators
- Direct Known Subclasses:
SpscChunkedAtomicUnpaddedArrayQueue
,SpscGrowableAtomicUnpaddedArrayQueue
,SpscUnboundedAtomicUnpaddedArrayQueue
abstract class BaseSpscLinkedAtomicUnpaddedArrayQueue<E> extends BaseSpscLinkedAtomicUnpaddedArrayQueueProducerColdFields<E> implements MessagePassingQueue<E>, QueueProgressIndicators
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 BaseSpscLinkedArrayQueue.java.
-
-
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 Description private static java.lang.Object
JUMP
-
Fields inherited from class org.jctools.queues.atomic.unpadded.BaseSpscLinkedAtomicUnpaddedArrayQueueProducerColdFields
producerBuffer, producerBufferLimit, producerMask
-
Fields inherited from class org.jctools.queues.atomic.unpadded.BaseSpscLinkedAtomicUnpaddedArrayQueueConsumerColdFields
consumerBuffer, consumerMask
-
Fields inherited from interface org.jctools.queues.MessagePassingQueue
UNBOUNDED_CAPACITY
-
-
Constructor Summary
Constructors Constructor Description BaseSpscLinkedAtomicUnpaddedArrayQueue()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description long
currentConsumerIndex()
This method has no concurrent visibility semantics.long
currentProducerIndex()
This method has no concurrent visibility semantics.int
drain(MessagePassingQueue.Consumer<E> c)
Remove all available item from the queue and hand to consume.int
drain(MessagePassingQueue.Consumer<E> c, int limit)
Remove up to limit elements from the queue and hand to consume.void
drain(MessagePassingQueue.Consumer<E> c, MessagePassingQueue.WaitStrategy wait, MessagePassingQueue.ExitCondition exit)
Remove elements from the queue and hand to consume forever.int
fill(MessagePassingQueue.Supplier<E> s)
Stuff the queue with elements from the supplier.int
fill(MessagePassingQueue.Supplier<E> s, int limit)
Stuff the queue with up to limit elements from the supplier.void
fill(MessagePassingQueue.Supplier<E> s, MessagePassingQueue.WaitStrategy wait, MessagePassingQueue.ExitCondition exit)
Stuff the queue with elements from the supplier forever.boolean
isEmpty()
This method's accuracy is subject to concurrent modifications happening as the observation is carried out.java.util.Iterator<E>
iterator()
(package private) void
linkOldToNew(long currIndex, java.util.concurrent.atomic.AtomicReferenceArray<E> oldBuffer, int offset, java.util.concurrent.atomic.AtomicReferenceArray<E> newBuffer, int offsetInNew, E e)
protected java.util.concurrent.atomic.AtomicReferenceArray<E>
lvNextArrayAndUnlink(java.util.concurrent.atomic.AtomicReferenceArray<E> curr)
private E
newBufferPeek(java.util.concurrent.atomic.AtomicReferenceArray<E> buffer, long index)
private E
newBufferPoll(java.util.concurrent.atomic.AtomicReferenceArray<E> buffer, long index)
boolean
offer(E e)
Called from a producer thread subject to the restrictions appropriate to the implementation and according to theQueue.offer(Object)
interface.(package private) abstract boolean
offerColdPath(java.util.concurrent.atomic.AtomicReferenceArray<E> buffer, long mask, long pIndex, int offset, E v, MessagePassingQueue.Supplier<? extends E> s)
E
peek()
Called from the consumer thread subject to the restrictions appropriate to the implementation and according to theQueue.peek()
interface.E
poll()
Called from the consumer thread subject to the restrictions appropriate to the implementation and according to theQueue.poll()
interface.boolean
relaxedOffer(E e)
Called from a producer thread subject to the restrictions appropriate to the implementation.E
relaxedPeek()
Called from the consumer thread subject to the restrictions appropriate to the implementation.E
relaxedPoll()
Called from the consumer thread subject to the restrictions appropriate to the implementation.int
size()
This method's accuracy is subject to concurrent modifications happening as the size is estimated and as such is a best effort rather than absolute value.protected void
soNext(java.util.concurrent.atomic.AtomicReferenceArray<E> curr, java.util.concurrent.atomic.AtomicReferenceArray<E> next)
java.lang.String
toString()
(package private) void
writeToQueue(java.util.concurrent.atomic.AtomicReferenceArray<E> buffer, E e, long index, int offset)
-
Methods inherited from class org.jctools.queues.atomic.unpadded.BaseSpscLinkedAtomicUnpaddedArrayQueueProducerFields
lpProducerIndex, lvProducerIndex, soProducerIndex
-
Methods inherited from class org.jctools.queues.atomic.unpadded.BaseSpscLinkedAtomicUnpaddedArrayQueueConsumerField
lpConsumerIndex, lvConsumerIndex, soConsumerIndex
-
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, toArray
-
Methods inherited from interface org.jctools.queues.IndexedQueueSizeUtil.IndexedQueue
capacity
-
Methods inherited from interface org.jctools.queues.MessagePassingQueue
capacity, clear
-
-
-
-
Method Detail
-
iterator
public final java.util.Iterator<E> iterator()
-
size
public final int size()
Description copied from interface:MessagePassingQueue
This method's accuracy is subject to concurrent modifications happening as the size is estimated and as such is a best effort rather than absolute value. For some implementations this method may be O(n) rather than O(1).- Specified by:
size
in interfacejava.util.Collection<E>
- Specified by:
size
in interfaceMessagePassingQueue<E>
- Specified by:
size
in classjava.util.AbstractCollection<E>
- Returns:
- number of messages in the queue, between 0 and
Integer.MAX_VALUE
but less or equals to capacity (if bounded).
-
isEmpty
public final boolean isEmpty()
Description copied from interface:MessagePassingQueue
This method's accuracy is subject to concurrent modifications happening as the observation is carried out.- Specified by:
isEmpty
in interfacejava.util.Collection<E>
- Specified by:
isEmpty
in interfaceMessagePassingQueue<E>
- Overrides:
isEmpty
in classjava.util.AbstractCollection<E>
- Returns:
- true if empty, false otherwise
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.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 interfaceQueueProgressIndicators
- 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 interfaceQueueProgressIndicators
- 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)
-
lvNextArrayAndUnlink
protected final java.util.concurrent.atomic.AtomicReferenceArray<E> lvNextArrayAndUnlink(java.util.concurrent.atomic.AtomicReferenceArray<E> curr)
-
relaxedOffer
public boolean relaxedOffer(E e)
Description copied from interface:MessagePassingQueue
Called from a producer thread subject to the restrictions appropriate to the implementation. As opposed toQueue.offer(Object)
this method may return false without the queue being full.- Specified by:
relaxedOffer
in interfaceMessagePassingQueue<E>
- Parameters:
e
- notnull
, will throw NPE if it is- Returns:
- true if element was inserted into the queue, false if unable to offer
-
relaxedPoll
public E relaxedPoll()
Description copied from interface:MessagePassingQueue
Called from the consumer thread subject to the restrictions appropriate to the implementation. As opposed toQueue.poll()
this method may returnnull
without the queue being empty.- Specified by:
relaxedPoll
in interfaceMessagePassingQueue<E>
- Returns:
- a message from the queue if one is available,
null
if unable to poll
-
relaxedPeek
public E relaxedPeek()
Description copied from interface:MessagePassingQueue
Called from the consumer thread subject to the restrictions appropriate to the implementation. As opposed toQueue.peek()
this method may returnnull
without the queue being empty.- Specified by:
relaxedPeek
in interfaceMessagePassingQueue<E>
- Returns:
- a message from the queue if one is available,
null
if unable to peek
-
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.WARNING: Explicit assumptions are made with regards to
MessagePassingQueue.Consumer.accept(T)
make sure you have read and understood these before using this method.- Specified by:
drain
in interfaceMessagePassingQueue<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.Unbounded queues will fill up the queue with a fixed amount rather than fill up to oblivion. WARNING: Explicit assumptions are made with regards to
MessagePassingQueue.Supplier.get()
make sure you have read and understood these before using this method.- Specified by:
fill
in interfaceMessagePassingQueue<E>
- Returns:
- the number of offered elements
-
drain
public int drain(MessagePassingQueue.Consumer<E> c, int limit)
Description copied from interface:MessagePassingQueue
Remove up to limit elements from the queue and hand to consume. This should be semantically similar to:M m; int i = 0; for(;i < limit && (m = relaxedPoll()) != null; i++){ c.accept(m); } return i;
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.
WARNING: Explicit assumptions are made with regards to
MessagePassingQueue.Consumer.accept(T)
make sure you have read and understood these before using this method.- Specified by:
drain
in interfaceMessagePassingQueue<E>
- Returns:
- the number of polled elements
-
fill
public int fill(MessagePassingQueue.Supplier<E> s, int limit)
Description copied from interface:MessagePassingQueue
Stuff the queue with up to limit elements from the supplier. Semantically similar to:for(int i=0; i < limit && relaxedOffer(s.get()); i++);
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. WARNING: Explicit assumptions are made with regards to
MessagePassingQueue.Supplier.get()
make sure you have read and understood these before using this method.- Specified by:
fill
in interfaceMessagePassingQueue<E>
- Returns:
- the number of offered elements
-
drain
public void drain(MessagePassingQueue.Consumer<E> c, MessagePassingQueue.WaitStrategy wait, MessagePassingQueue.ExitCondition exit)
Description copied from interface:MessagePassingQueue
Remove elements from the queue and hand to consume forever. Semantically similar to:int idleCounter = 0; while (exit.keepRunning()) { E e = relaxedPoll(); if(e==null){ idleCounter = wait.idle(idleCounter); continue; } idleCounter = 0; c.accept(e); }
Called from a consumer thread subject to the restrictions appropriate to the implementation.
WARNING: Explicit assumptions are made with regards to
MessagePassingQueue.Consumer.accept(T)
make sure you have read and understood these before using this method.- Specified by:
drain
in interfaceMessagePassingQueue<E>
-
fill
public void fill(MessagePassingQueue.Supplier<E> s, MessagePassingQueue.WaitStrategy wait, MessagePassingQueue.ExitCondition exit)
Description copied from interface:MessagePassingQueue
Stuff the queue with elements from the supplier forever. Semantically similar to:int idleCounter = 0; while (exit.keepRunning()) { E e = s.get(); while (!relaxedOffer(e)) { idleCounter = wait.idle(idleCounter); continue; } idleCounter = 0; }
Called from a producer thread subject to the restrictions appropriate to the implementation. The main difference being that implementors MUST assure room in the queue is available BEFORE calling
MessagePassingQueue.Supplier.get()
. WARNING: Explicit assumptions are made with regards toMessagePassingQueue.Supplier.get()
make sure you have read and understood these before using this method.- Specified by:
fill
in interfaceMessagePassingQueue<E>
-
offer
public boolean offer(E e)
Called from a producer thread subject to the restrictions appropriate to the implementation and according to theQueue.offer(Object)
interface.This implementation is correct for single producer thread use only.
- Specified by:
offer
in interfaceMessagePassingQueue<E>
- Specified by:
offer
in interfacejava.util.Queue<E>
- Parameters:
e
- notnull
, will throw NPE if it is- Returns:
- true if element was inserted into the queue, false iff full
-
offerColdPath
abstract boolean offerColdPath(java.util.concurrent.atomic.AtomicReferenceArray<E> buffer, long mask, long pIndex, int offset, E v, MessagePassingQueue.Supplier<? extends E> s)
-
poll
public E poll()
Called from the consumer thread subject to the restrictions appropriate to the implementation and according to theQueue.poll()
interface.This implementation is correct for single consumer thread use only.
- Specified by:
poll
in interfaceMessagePassingQueue<E>
- Specified by:
poll
in interfacejava.util.Queue<E>
- Returns:
- a message from the queue if one is available,
null
iff empty
-
peek
public E peek()
Called from the consumer thread subject to the restrictions appropriate to the implementation and according to theQueue.peek()
interface.This implementation is correct for single consumer thread use only.
- Specified by:
peek
in interfaceMessagePassingQueue<E>
- Specified by:
peek
in interfacejava.util.Queue<E>
- Returns:
- a message from the queue if one is available,
null
iff empty
-
linkOldToNew
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
final void writeToQueue(java.util.concurrent.atomic.AtomicReferenceArray<E> buffer, E e, long index, int offset)
-
newBufferPeek
private E newBufferPeek(java.util.concurrent.atomic.AtomicReferenceArray<E> buffer, long index)
-
-