Caffeine cache 3.1.8 · com.github.benmanes.caffeine.cache.BaseMpscLinkedArrayQueue

Modifier and Type	Field and Description
pack-priv static final VarHandle	C_INDEX
private static final Object	JUMP
pack-priv static final VarHandle	P_INDEX
pack-priv static final VarHandle	P_LIMIT
pack-priv static final VarHandle	REF_ARRAY

Access	Constructor and Description
pack-priv	BaseMpscLinkedArrayQueue(final int the queue initial capacity. If chunk size is fixed this will be the chunk size. Must be 2 or more. initialCapacity)

Method Summary

Modifier and Type	Method and Description
public static <E> E[]	allocate(int capacity)
protected abstract long	Returns: available elements in queue * 2 availableInQueue(long pIndex, final long cIndex)
public abstract int	capacity()
pack-priv static boolean	casProducerIndex(BaseMpscLinkedArrayQueue<?> self, long expect, long newValue)
pack-priv static boolean	casProducerLimit(BaseMpscLinkedArrayQueue<?> self, long expect, long newValue)
public long	currentConsumerIndex()
public long	currentProducerIndex()
protected abstract long	Returns: current buffer capacity for elements (excluding next pointer and jump entry) * 2 getCurrentBufferCapacity(long mask)
private E[]	getNextBuffer(final E[] buffer, final long mask)
protected abstract int	Returns: next buffer size(inclusive of next array pointer) getNextBufferSize(E[] buffer)
public final boolean	isEmpty() Overrides java.util.AbstractCollection.isEmpty. Implements java.util.Collection.isEmpty. Returns `true` if this collection contains no elements.
public final Iterator<E>	iterator() Implements abstract java.util.AbstractCollection.iterator. Implements java.util.Collection.iterator. Returns an iterator over the elements in this collection.
pack-priv static long	lvConsumerIndex(BaseMpscLinkedArrayQueue<?> self)
pack-priv static <E> E	Returns: the element at the offset lvElement(E[] this.buffer buffer, long computed offset) A volatile load (load + LoadLoad barrier) of an element from a given offset.
pack-priv static long	lvProducerIndex(BaseMpscLinkedArrayQueue<?> self)
private long	lvProducerLimit()
pack-priv static long	modifiedCalcElementOffset(long index, long mask) This method assumes index is actually (index << 1) because lower bit is used for resize.
private long	newBufferAndOffset(E[] nextBuffer, final long index)
private E	newBufferPeek(E[] nextBuffer, final long index)
private E	newBufferPoll(E[] nextBuffer, final long index)
private long	nextArrayOffset(final long mask)
public boolean	offer(final E the element to add e) Implements java.util.Queue.offer. Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions.
private int	offerSlowPath(long mask, long pIndex, long producerLimit) We do not inline resize into this method because we do not resize on fill.
public E	peek() Implements java.util.Queue.peek. Retrieves, but does not remove, the head of this queue, or returns `null` if this queue is empty.
public E	poll() Implements java.util.Queue.poll. Retrieves and removes the head of this queue, or returns `null` if this queue is empty.
public boolean	relaxedOffer(E e)
public E	relaxedPeek()
public E	relaxedPoll()
private void	resize(long oldMask, E[] oldBuffer, long pIndex, final E e)
public final int	size() Implements abstract java.util.AbstractCollection.size. Implements java.util.Collection.size. Returns the number of elements in this collection.
pack-priv static void	soConsumerIndex(BaseMpscLinkedArrayQueue<?> self, long v)
pack-priv static <E> void	soElement(E[] this.buffer buffer, long computed offset, E an orderly kitty e) An ordered store(store + StoreStore barrier) of an element to a given offset
pack-priv static void	soProducerIndex(BaseMpscLinkedArrayQueue<?> self, long v)
pack-priv static void	soProducerLimit(BaseMpscLinkedArrayQueue<?> self, long v)
public String	toString() Overrides java.util.AbstractCollection.toString. Returns a string representation of this collection.

C_INDEX	back to summary
pack-priv static final VarHandle C_INDEX

JUMP	back to summary
private static final Object JUMP

P_INDEX	back to summary
pack-priv static final VarHandle P_INDEX

P_LIMIT	back to summary
pack-priv static final VarHandle P_LIMIT

REF_ARRAY	back to summary
pack-priv static final VarHandle REF_ARRAY

BaseMpscLinkedArrayQueue	back to summary
pack-priv BaseMpscLinkedArrayQueue(final int initialCapacity) Parameters initialCapacity:int the queue initial capacity. If chunk size is fixed this will be the chunk size. Must be 2 or more.

Method Detail

allocate	back to summary
public static <E> E[] allocate(int capacity) Annotations @SuppressWarnings:unchecked

availableInQueue	back to summary
protected abstract long availableInQueue(long pIndex, final long cIndex) Returns:long available elements in queue * 2

capacity	back to summary
public abstract int capacity()

casProducerIndex	back to summary
pack-priv static boolean casProducerIndex(BaseMpscLinkedArrayQueue<?> self, long expect, long newValue)

casProducerLimit	back to summary
pack-priv static boolean casProducerLimit(BaseMpscLinkedArrayQueue<?> self, long expect, long newValue)

currentConsumerIndex	back to summary
public long currentConsumerIndex()

currentProducerIndex	back to summary
public long currentProducerIndex()

getCurrentBufferCapacity	back to summary
protected abstract long getCurrentBufferCapacity(long mask) Returns:long current buffer capacity for elements (excluding next pointer and jump entry) * 2

getNextBuffer	back to summary
private E[] getNextBuffer(final E[] buffer, final long mask) Annotations @SuppressWarnings:unchecked

getNextBufferSize	back to summary
protected abstract int getNextBufferSize(E[] buffer) Returns:int next buffer size(inclusive of next array pointer)

isEmpty back to summary

isEmpty	back to summary
public final boolean isEmpty() Overrides java.util.AbstractCollection.isEmpty. Implements java.util.Collection.isEmpty. Doc from java.util.Collection.isEmpty. Returns `true` if this collection contains no elements. Returns:boolean `true` if this collection contains no elements Annotations @Override

public final boolean isEmpty()

Overrides java.util.AbstractCollection.isEmpty.

Implements java.util.Collection.isEmpty.

Doc from java.util.Collection.isEmpty.

Returns true if this collection contains no elements.

Returns:boolean

true if this collection contains no elements

Annotations

@Override

iterator back to summary

iterator	back to summary
public final Iterator<E> iterator() Implements abstract java.util.AbstractCollection.iterator. Implements java.util.Collection.iterator. Doc from java.util.Collection.iterator. Returns an iterator over the elements in this collection. There are no guarantees concerning the order in which the elements are returned (unless this collection is an instance of some class that provides a guarantee). Returns:Iterator<E> an `Iterator` over the elements in this collection Annotations @Override

public final Iterator<E> iterator()

Implements abstract java.util.AbstractCollection.iterator.

Implements java.util.Collection.iterator.

Doc from java.util.Collection.iterator.

Returns an iterator over the elements in this collection. There are no guarantees concerning the order in which the elements are returned (unless this collection is an instance of some class that provides a guarantee).

Returns:Iterator<E>

an Iterator over the elements in this collection

Annotations

@Override

lvConsumerIndex	back to summary
pack-priv static long lvConsumerIndex(BaseMpscLinkedArrayQueue<?> self)

lvElement	back to summary
pack-priv static <E> E lvElement(E[] buffer, long offset) A volatile load (load + LoadLoad barrier) of an element from a given offset. Parameters buffer:E[] this.buffer offset:long computed Returns:E the element at the offset Annotations @SuppressWarnings:unchecked

lvElement

back to summary

pack-priv static <E> E lvElement(E[] buffer, long offset)

A volatile load (load + LoadLoad barrier) of an element from a given offset.

Parameters

buffer:E[]: this.buffer
offset:long: computed

Returns:E

the element at the offset

Annotations

@SuppressWarnings:unchecked

lvProducerIndex	back to summary
pack-priv static long lvProducerIndex(BaseMpscLinkedArrayQueue<?> self)

lvProducerLimit	back to summary
private long lvProducerLimit()

modifiedCalcElementOffset	back to summary
pack-priv static long modifiedCalcElementOffset(long index, long mask) This method assumes index is actually (index << 1) because lower bit is used for resize. This is compensated for by reducing the element shift. The computation is constant folded, so there's no cost.

newBufferAndOffset	back to summary
private long newBufferAndOffset(E[] nextBuffer, final long index)

newBufferPeek	back to summary
private E newBufferPeek(E[] nextBuffer, final long index)

newBufferPoll	back to summary
private E newBufferPoll(E[] nextBuffer, final long index)

nextArrayOffset	back to summary
private long nextArrayOffset(final long mask)

offer back to summary

offer	back to summary
public boolean offer(final E e) Implements java.util.Queue.offer. Doc from java.util.Queue.offer. Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions. When using a capacity-restricted queue, this method is generally preferable to `add`, which can fail to insert an element only by throwing an exception. Parameters e:E the element to add Returns:boolean `true` if the element was added to this queue, else `false` Annotations @Override @SuppressWarnings:MissingDefault

public boolean offer(final E e)

Implements java.util.Queue.offer.

Doc from java.util.Queue.offer.

Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions. When using a capacity-restricted queue, this method is generally preferable to add, which can fail to insert an element only by throwing an exception.

Parameters

e:E: the element to add

Returns:boolean

true if the element was added to this queue, else false

Annotations

@Override
@SuppressWarnings:MissingDefault

offerSlowPath	back to summary
private int offerSlowPath(long mask, long pIndex, long producerLimit) We do not inline resize into this method because we do not resize on fill.

peek back to summary

peek	back to summary
public E peek() Implements java.util.Queue.peek. Doc from java.util.Queue.peek. Retrieves, but does not remove, the head of this queue, or returns `null` if this queue is empty. This implementation is correct for single consumer thread use only. Returns:E the head of this queue, or `null` if this queue is empty Annotations @SuppressWarnings:unchecked @Override

public E peek()

Implements java.util.Queue.peek.

Doc from java.util.Queue.peek.

Retrieves, but does not remove, the head of this queue, or returns null if this queue is empty.

This implementation is correct for single consumer thread use only.

Returns:E

the head of this queue, or null if this queue is empty

Annotations

@SuppressWarnings:unchecked
@Override

poll back to summary

poll	back to summary
public E poll() Implements java.util.Queue.poll. Doc from java.util.Queue.poll. Retrieves and removes the head of this queue, or returns `null` if this queue is empty. This implementation is correct for single consumer thread use only. Returns:E the head of this queue, or `null` if this queue is empty Annotations @Override @SuppressWarnings:unchecked

public E poll()

Implements java.util.Queue.poll.

Doc from java.util.Queue.poll.

Retrieves and removes the head of this queue, or returns null if this queue is empty.

This implementation is correct for single consumer thread use only.

Returns:E

the head of this queue, or null if this queue is empty

Annotations

@Override
@SuppressWarnings:unchecked

relaxedOffer	back to summary
public boolean relaxedOffer(E e)

relaxedPeek	back to summary
public E relaxedPeek() Annotations @SuppressWarnings:unchecked

relaxedPoll	back to summary
public E relaxedPoll() Annotations @SuppressWarnings:unchecked

resize	back to summary
private void resize(long oldMask, E[] oldBuffer, long pIndex, final E e)

size back to summary

size	back to summary
public final int size() Implements abstract java.util.AbstractCollection.size. Implements java.util.Collection.size. Doc from java.util.Collection.size. Returns the number of elements in this collection. If this collection contains more than `Integer.MAX_VALUE` elements, returns `Integer.MAX_VALUE`. Returns:int the number of elements in this collection Annotations @Override

public final int size()

Implements abstract java.util.AbstractCollection.size.

Implements java.util.Collection.size.

Doc from java.util.Collection.size.

Returns the number of elements in this collection. If this collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:int

the number of elements in this collection

Annotations

@Override

soConsumerIndex	back to summary
pack-priv static void soConsumerIndex(BaseMpscLinkedArrayQueue<?> self, long v)

soElement	back to summary
pack-priv static <E> void soElement(E[] buffer, long offset, E e) An ordered store(store + StoreStore barrier) of an element to a given offset Parameters buffer:E[] this.buffer offset:long computed e:E an orderly kitty

soElement

back to summary

pack-priv static <E> void soElement(E[] buffer, long offset, E e)

An ordered store(store + StoreStore barrier) of an element to a given offset

Parameters

buffer:E[]: this.buffer
offset:long: computed
e:E: an orderly kitty

soProducerIndex	back to summary
pack-priv static void soProducerIndex(BaseMpscLinkedArrayQueue<?> self, long v)

soProducerLimit	back to summary
pack-priv static void soProducerLimit(BaseMpscLinkedArrayQueue<?> self, long v)

toString back to summary

toString	back to summary
public String toString() Overrides java.util.AbstractCollection.toString. Doc from java.util.AbstractCollection.toString. Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in square brackets (`"[]"`). Adjacent elements are separated by the characters `", "` (comma and space). Elements are converted to strings as by `String#valueOf(Object)`. Returns:String a string representation of this collection Annotations @Override

public String toString()

Overrides java.util.AbstractCollection.toString.

Doc from java.util.AbstractCollection.toString.

Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in square brackets ("[]"). Adjacent elements are separated by the characters ", " (comma and space). Elements are converted to strings as by String#valueOf(Object).

Returns:String

a string representation of this collection

Annotations

@Override

pack-priv abstract Class BaseMpscLinkedArrayQueue<E>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail