java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractQueue<E>
  - - org.jctools.queues.atomic.SpscChunkedAtomicArrayQueue<E>

Type Parameters:

E -

All Implemented Interfaces:

Iterable<E>, Collection<E>, Queue<E>, IndexedQueueSizeUtil.IndexedQueue, MessagePassingQueue<E>, QueueProgressIndicators
```
public class SpscChunkedAtomicArrayQueue<E>
extends AbstractQueue<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 SpscChunkedArrayQueue.java. An SPSC array queue which starts at initialCapacity and grows to maxCapacity 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	Description
`protected AtomicReferenceArray<E>`	`consumerBuffer`
`protected long`	`consumerMask`
`protected AtomicReferenceArray<E>`	`producerBuffer`
`protected long`	`producerBufferLimit`
`protected long`	`producerMask`

Fields inherited from interface org.jctools.queues.MessagePassingQueue
UNBOUNDED_CAPACITY

Constructor Summary

Constructors
Constructor Description

SpscChunkedAtomicArrayQueue(int capacity)

SpscChunkedAtomicArrayQueue(int chunkSize, int capacity)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`capacity()`
`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.
`Iterator<E>`	`iterator()`
`long`	`lvConsumerIndex()`
`protected AtomicReferenceArray<E>`	`lvNextArrayAndUnlink(AtomicReferenceArray<E> curr)`
`long`	`lvProducerIndex()`
`boolean`	`offer(E e)`	Called from a producer thread subject to the restrictions appropriate to the implementation and according to the `Queue.offer(Object)` interface.
`E`	`peek()`	Called from the consumer thread subject to the restrictions appropriate to the implementation and according to the `Queue.peek()` interface.
`E`	`poll()`	Called from the consumer thread subject to the restrictions appropriate to the implementation and according to the `Queue.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(AtomicReferenceArray<E> curr, AtomicReferenceArray<E> next)`
`String`	`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 java.util.Collection
contains, containsAll, equals, hashCode, parallelStream, remove, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray, toArray

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface org.jctools.queues.MessagePassingQueue
clear

- Field Detail
  - producerBufferLimit
```
protected long producerBufferLimit
```
  - producerMask
```
protected long producerMask
```
  - producerBuffer
```
protected AtomicReferenceArray<E> producerBuffer
```
  - consumerMask
```
protected long consumerMask
```
  - consumerBuffer
```
protected AtomicReferenceArray<E> consumerBuffer
```
- Constructor Detail
  - SpscChunkedAtomicArrayQueue
```
public SpscChunkedAtomicArrayQueue(int capacity)
```
  - SpscChunkedAtomicArrayQueue
```
public SpscChunkedAtomicArrayQueue(int chunkSize,
                                   int capacity)
```
- Method Detail
  - capacity
```
public int capacity()
```
    Returns:
    
    the capacity of this queue or MessagePassingQueue.UNBOUNDED_CAPACITY if not bounded
  - iterator
```
public final Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface Collection<E>
    
    Specified by:
    
    iterator in interface Iterable<E>
    
    Specified by:
    
    iterator in class AbstractCollection<E>
  - 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 interface Collection<E>
    
    Specified by:
    
    size in interface MessagePassingQueue<E>
    
    Specified by:
    
    size in class 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 interface Collection<E>
    
    Specified by:
    
    isEmpty in interface MessagePassingQueue<E>
    
    Overrides:
    
    isEmpty in class AbstractCollection<E>
    
    Returns:
    
    true if empty, false otherwise
  - toString
```
public String toString()
```
    Overrides:
    
    toString 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
  - soNext
```
protected final void soNext(AtomicReferenceArray<E> curr,
                            AtomicReferenceArray<E> next)
```
  - lvNextArrayAndUnlink
```
protected final AtomicReferenceArray<E> lvNextArrayAndUnlink(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 to Queue.offer(Object) this method may return false without the queue being full.
    
    Specified by:
    
    relaxedOffer in interface MessagePassingQueue<E>
    
    Parameters:
    
    e - not null, 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 to Queue.poll() this method may return null without the queue being empty.
    
    Specified by:
    
    relaxedPoll in interface MessagePassingQueue<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 to Queue.peek() this method may return null without the queue being empty.
    
    Specified by:
    
    relaxedPeek in interface MessagePassingQueue<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 interface MessagePassingQueue<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 interface MessagePassingQueue<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 interface MessagePassingQueue<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 interface MessagePassingQueue<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 interface MessagePassingQueue<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 to MessagePassingQueue.Supplier.get() make sure you have read and understood these before using this method.
    Specified by:
    
    fill in interface MessagePassingQueue<E>
  - offer
```
public boolean offer(E e)
```
    Called from a producer thread subject to the restrictions appropriate to the implementation and according to the Queue.offer(Object) interface.
    This implementation is correct for single producer thread use only.
    
    Specified by:
    
    offer in interface MessagePassingQueue<E>
    
    Specified by:
    
    offer in interface Queue<E>
    
    Parameters:
    
    e - not null, will throw NPE if it is
    
    Returns:
    
    true if element was inserted into the queue, false iff full
  - poll
```
public E poll()
```
    Called from the consumer thread subject to the restrictions appropriate to the implementation and according to the Queue.poll() interface.
    This implementation is correct for single consumer thread use only.
    
    Specified by:
    
    poll in interface MessagePassingQueue<E>
    
    Specified by:
    
    poll in interface 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 the Queue.peek() interface.
    This implementation is correct for single consumer thread use only.
    
    Specified by:
    
    peek in interface MessagePassingQueue<E>
    
    Specified by:
    
    peek in interface Queue<E>
    
    Returns:
    
    a message from the queue if one is available, null iff empty
  - lvProducerIndex
```
public final long lvProducerIndex()
```
  - lvConsumerIndex
```
public final long lvConsumerIndex()
```

Constructor	Description
`SpscChunkedAtomicArrayQueue(int capacity)`
`SpscChunkedAtomicArrayQueue(int chunkSize, int capacity)`

Class SpscChunkedAtomicArrayQueue<E>

Nested Class Summary

Nested classes/interfaces inherited from interface org.jctools.queues.MessagePassingQueue

Field Summary

Fields inherited from interface org.jctools.queues.MessagePassingQueue

Constructor Summary

Method Summary

Methods inherited from class java.util.AbstractQueue

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Methods inherited from interface org.jctools.queues.MessagePassingQueue

Field Detail

producerBufferLimit

producerMask

producerBuffer

consumerMask

consumerBuffer

Constructor Detail

SpscChunkedAtomicArrayQueue

SpscChunkedAtomicArrayQueue

Method Detail

capacity

iterator

size

isEmpty

toString

currentProducerIndex

currentConsumerIndex

soNext

lvNextArrayAndUnlink

relaxedOffer

relaxedPoll

relaxedPeek

drain

fill

drain

fill

drain

fill

offer

poll

peek

lvProducerIndex

lvConsumerIndex