Package org.jctools.queues
Class ConcurrentSequencedCircularArrayQueue<E>
- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- java.util.AbstractQueue<E>
-
- org.jctools.queues.ConcurrentSequencedCircularArrayQueue<E>
-
- All Implemented Interfaces:
Iterable<E>,Collection<E>,Queue<E>,IndexedQueueSizeUtil.IndexedQueue,MessagePassingQueue<E>,QueueProgressIndicators,SupportsIterator
- Direct Known Subclasses:
MpmcArrayQueue
public abstract class ConcurrentSequencedCircularArrayQueue<E> extends AbstractQueue<E>
-
-
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 protected E[]bufferprotected longmaskprotected long[]sequenceBuffer-
Fields inherited from interface org.jctools.queues.MessagePassingQueue
UNBOUNDED_CAPACITY
-
-
Constructor Summary
Constructors Constructor Description ConcurrentSequencedCircularArrayQueue(int capacity)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intcapacity()voidclear()Removes all items from the queue.longcurrentConsumerIndex()This method has no concurrent visibility semantics.longcurrentProducerIndex()This method has no concurrent visibility semantics.booleanisEmpty()This method's accuracy is subject to concurrent modifications happening as the observation is carried out.Iterator<E>iterator()Get an iterator for this queue.intsize()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.StringtoString()-
Methods inherited from class java.util.AbstractQueue
add, addAll, 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, toArray
-
Methods inherited from interface org.jctools.queues.IndexedQueueSizeUtil.IndexedQueue
lvConsumerIndex, lvProducerIndex
-
Methods inherited from interface org.jctools.queues.MessagePassingQueue
drain, drain, drain, fill, fill, fill, offer, peek, poll, relaxedOffer, relaxedPeek, relaxedPoll
-
-
-
-
Method Detail
-
size
public int size()
Description copied from interface:MessagePassingQueueThis 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:
sizein interfaceCollection<E>- Specified by:
sizein interfaceMessagePassingQueue<E>- Specified by:
sizein classAbstractCollection<E>- Returns:
- number of messages in the queue, between 0 and
Integer.MAX_VALUEbut less or equals to capacity (if bounded).
-
isEmpty
public boolean isEmpty()
Description copied from interface:MessagePassingQueueThis method's accuracy is subject to concurrent modifications happening as the observation is carried out.- Specified by:
isEmptyin interfaceCollection<E>- Specified by:
isEmptyin interfaceMessagePassingQueue<E>- Overrides:
isEmptyin classAbstractCollection<E>- Returns:
- true if empty, false otherwise
-
toString
public String toString()
- Overrides:
toStringin classAbstractCollection<E>
-
clear
public void clear()
Description copied from interface:MessagePassingQueueRemoves all items from the queue. Called from the consumer thread subject to the restrictions appropriate to the implementation and according to theCollection.clear()interface.- Specified by:
clearin interfaceCollection<E>- Specified by:
clearin interfaceMessagePassingQueue<E>- Overrides:
clearin classAbstractQueue<E>
-
capacity
public int capacity()
- Specified by:
capacityin interfaceIndexedQueueSizeUtil.IndexedQueue- Specified by:
capacityin interfaceMessagePassingQueue<E>- Returns:
- the capacity of this queue or
MessagePassingQueue.UNBOUNDED_CAPACITYif not bounded
-
currentProducerIndex
public long currentProducerIndex()
Description copied from interface:QueueProgressIndicatorsThis 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:
currentProducerIndexin interfaceQueueProgressIndicators- Returns:
- the current value of the producer progress index
-
currentConsumerIndex
public long currentConsumerIndex()
Description copied from interface:QueueProgressIndicatorsThis 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:
currentConsumerIndexin interfaceQueueProgressIndicators- Returns:
- the current value of the consumer progress index
-
iterator
public Iterator<E> iterator()
Get an iterator for this queue. This method is thread safe.The iterator provides a best-effort snapshot of the elements in the queue. The returned iterator is not guaranteed to return elements in queue order, and races with the consumer thread may cause gaps in the sequence of returned elements. Like {link #relaxedPoll}, the iterator may not immediately return newly inserted elements.
- Specified by:
iteratorin interfaceCollection<E>- Specified by:
iteratorin interfaceIterable<E>- Specified by:
iteratorin classAbstractCollection<E>- Returns:
- The iterator.
-
-