Class SpscUnboundedVarHandleUnpaddedArrayQueue<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

org.jctools.queues.varhandle.unpadded.BaseSpscLinkedVarHandleUnpaddedArrayQueuePrePad<E>

org.jctools.queues.varhandle.unpadded.BaseSpscLinkedVarHandleUnpaddedArrayQueueConsumerColdFields<E>

org.jctools.queues.varhandle.unpadded.BaseSpscLinkedVarHandleUnpaddedArrayQueueConsumerField<E>

org.jctools.queues.varhandle.unpadded.BaseSpscLinkedVarHandleUnpaddedArrayQueueL2Pad<E>

org.jctools.queues.varhandle.unpadded.BaseSpscLinkedVarHandleUnpaddedArrayQueueProducerFields<E>

org.jctools.queues.varhandle.unpadded.BaseSpscLinkedVarHandleUnpaddedArrayQueueProducerColdFields<E>

org.jctools.queues.varhandle.unpadded.BaseSpscLinkedVarHandleUnpaddedArrayQueue<E>

org.jctools.queues.varhandle.unpadded.SpscUnboundedVarHandleUnpaddedArrayQueue<E>

Type Parameters:

E -

All Implemented Interfaces:

Iterable<E>, Collection<E>, Queue<E>, IndexedQueueSizeUtil.IndexedQueue, MessagePassingQueue<E>, QueueProgressIndicators

public class SpscUnboundedVarHandleUnpaddedArrayQueue<E>
extends BaseSpscLinkedVarHandleUnpaddedArrayQueue<E>

NOTE: This class was automatically generated by org.jctools.queues.varhandle.unpadded.JavaParsingVarHandleUnpaddedLinkedQueueGenerator which can found in the jctools-build module. The original source file is SpscUnboundedArrayQueue.java. An SPSC array queue which starts at initialCapacity and grows indefinitely 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 MessagePassingQueue

MessagePassingQueue.Consumer<T>, MessagePassingQueue.ExitCondition, MessagePassingQueue.Supplier<T>, MessagePassingQueue.WaitStrategy

Field Summary

Fields inherited from class BaseSpscLinkedVarHandleUnpaddedArrayQueueProducerColdFields

producerBuffer, producerBufferLimit, producerMask

Fields inherited from class BaseSpscLinkedVarHandleUnpaddedArrayQueueConsumerColdFields

consumerBuffer, consumerMask

Fields inherited from interface MessagePassingQueue

UNBOUNDED_CAPACITY

Constructor Summary

Constructors

Constructor	Description
SpscUnboundedVarHandleUnpaddedArrayQueue(int chunkSize)

Method Summary

Modifier and Type	Method	Description
int	capacity()
int	fill(MessagePassingQueue.Supplier<E> s)	Stuff the queue with elements from the supplier.
(package private) final boolean	offerColdPath(E[] buffer, long mask, long pIndex, long offset, E v, MessagePassingQueue.Supplier<? extends E> s)

Methods inherited from class BaseSpscLinkedVarHandleUnpaddedArrayQueue

currentConsumerIndex, currentProducerIndex, drain, drain, drain, fill, fill, isEmpty, iterator, linkOldToNew, lvNextArrayAndUnlink, offer, peek, poll, relaxedOffer, relaxedPeek, relaxedPoll, size, soNext, toString, writeToQueue

Methods inherited from class BaseSpscLinkedVarHandleUnpaddedArrayQueueProducerFields

lpProducerIndex, lvProducerIndex, soProducerIndex

Methods inherited from class BaseSpscLinkedVarHandleUnpaddedArrayQueueConsumerField

lpConsumerIndex, lvConsumerIndex, soConsumerIndex

Methods inherited from class AbstractQueue

add, addAll, clear, element, remove

Methods inherited from class AbstractCollection

contains, containsAll, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class Object

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

Methods inherited from interface Collection

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

Methods inherited from interface Iterable

forEach

Methods inherited from interface MessagePassingQueue

clear

Constructor Details

SpscUnboundedVarHandleUnpaddedArrayQueue

public SpscUnboundedVarHandleUnpaddedArrayQueue(int chunkSize)

Method Details

offerColdPath

final boolean offerColdPath(E[] buffer,
 long mask,
 long pIndex,
 long offset,
 E v,
 MessagePassingQueue.Supplier<? extends E> s)

Specified by:

offerColdPath in class BaseSpscLinkedVarHandleUnpaddedArrayQueue<E>

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>

Overrides:

fill in class BaseSpscLinkedVarHandleUnpaddedArrayQueue<E>

Returns:

the number of offered elements

capacity

public int capacity()

Returns:

the capacity of this queue or MessagePassingQueue.UNBOUNDED_CAPACITY if not bounded