Netty 4.1.107.Final · io.netty.util.internal.shaded.org.jctools.queues.atomic.BaseLinkedAtomicQueue

Access	Constructor and Description
pack-priv	BaseLinkedAtomicQueue()

Method Summary

Modifier and Type	Method and Description
public int	capacity() Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.capacity.
public int	drain(MessagePassingQueue.Consumer<E> c, int limit) Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.drain. Remove up to limit elements from the queue and hand to consume.
public int	drain(MessagePassingQueue.Consumer<E> c) Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.drain. Remove all available item from the queue and hand to consume.
public void	drain(MessagePassingQueue.Consumer<E> c, MessagePassingQueue.WaitStrategy wait, MessagePassingQueue.ExitCondition exit) Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.drain. Remove elements from the queue and hand to consume forever.
protected E	getSingleConsumerNodeValue(LinkedQueueAtomicNode<E> currConsumerNode, LinkedQueueAtomicNode<E> nextNode)
public boolean	isEmpty() Overrides java.util.AbstractCollection.isEmpty. Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.isEmpty, java.util.Collection.isEmpty. This method's accuracy is subject to concurrent modifications happening as the observation is carried out.
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.
protected final LinkedQueueAtomicNode<E>	newNode()
protected final LinkedQueueAtomicNode<E>	newNode(E e)
public E	peek() Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.peek, java.util.Queue.peek. Called from the consumer thread subject to the restrictions appropriate to the implementation and according to the `Queue#peek()` interface.
public E	poll() Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.poll, java.util.Queue.poll. Called from the consumer thread subject to the restrictions appropriate to the implementation and according to the `Queue#poll()` interface.
public boolean	relaxedOffer(E not `null`, will throw NPE if it is e) Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.relaxedOffer. Called from a producer thread subject to the restrictions appropriate to the implementation.
public E	relaxedPeek() Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.relaxedPeek. Called from the consumer thread subject to the restrictions appropriate to the implementation.
public E	relaxedPoll() Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.relaxedPoll. Called from the consumer thread subject to the restrictions appropriate to the implementation.
public final int	size() Implements abstract java.util.AbstractCollection.size. Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.size, java.util.Collection.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.
pack-priv LinkedQueueAtomicNode<E>	spinWaitForNextNode(LinkedQueueAtomicNode<E> currNode)
public String	toString() Overrides java.util.AbstractCollection.toString. Returns a string representation of this collection.

BaseLinkedAtomicQueue	back to summary
pack-priv BaseLinkedAtomicQueue()

Method Detail

capacity back to summary

capacity	back to summary
public int capacity() Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.capacity. Returns:int Doc from io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.capacity. the capacity of this queue or `MessagePassingQueue#UNBOUNDED_CAPACITY` if not bounded Annotations @Override

public int capacity()

Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.capacity.

Returns:int

Doc from io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.capacity.

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

Annotations

@Override

drain back to summary

drain	back to summary
public int drain(MessagePassingQueue.Consumer<E> c, int limit) Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.drain. Doc from io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.drain. 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 `Consumer#accept` make sure you have read and understood these before using this method. Returns:int the number of polled elements Annotations @Override

public int drain(MessagePassingQueue.Consumer<E> c, int limit)

Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.drain.

Doc from io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.drain.

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 Consumer#accept make sure you have read and understood these before using this method.

Returns:int

the number of polled elements

Annotations

@Override

drain back to summary

drain	back to summary
public int drain(MessagePassingQueue.Consumer<E> c) Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.drain. Doc from io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.drain. 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 `Consumer#accept` make sure you have read and understood these before using this method. Returns:int the number of polled elements Annotations @Override

public int drain(MessagePassingQueue.Consumer<E> c)

Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.drain.

Doc from io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.drain.

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 Consumer#accept make sure you have read and understood these before using this method.

Returns:int

the number of polled elements

Annotations

@Override

drain back to summary

drain	back to summary
public void drain(MessagePassingQueue.Consumer<E> c, MessagePassingQueue.WaitStrategy wait, MessagePassingQueue.ExitCondition exit) Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.drain. Doc from io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.drain. 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 `Consumer#accept` make sure you have read and understood these before using this method. Annotations @Override

public void drain(MessagePassingQueue.Consumer<E> c, MessagePassingQueue.WaitStrategy wait, MessagePassingQueue.ExitCondition exit)

Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.drain.

Doc from io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.drain.

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 Consumer#accept make sure you have read and understood these before using this method.

Annotations

@Override

getSingleConsumerNodeValue	back to summary
protected E getSingleConsumerNodeValue(LinkedQueueAtomicNode<E> currConsumerNode, LinkedQueueAtomicNode<E> nextNode)

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Overrides java.util.AbstractCollection.isEmpty. Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.isEmpty, java.util.Collection.isEmpty. Doc from io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.isEmpty. This method's accuracy is subject to concurrent modifications happening as the observation is carried out. Implementation Notes Queue is empty when producerNode is the same as consumerNode. An alternative implementation would be to observe the producerNode.value is null, which also means an empty queue because only the consumerNode.value is allowed to be null. Returns:boolean true if empty, false otherwise Annotations @Override See Also `MessagePassingQueue#isEmpty()`

public boolean isEmpty()

Overrides java.util.AbstractCollection.isEmpty.

Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.isEmpty, java.util.Collection.isEmpty.

Doc from io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.isEmpty.

This method's accuracy is subject to concurrent modifications happening as the observation is carried out.

Implementation Notes

Queue is empty when producerNode is the same as consumerNode. An alternative implementation would be to observe the producerNode.value is null, which also means an empty queue because only the consumerNode.value is allowed to be null.

Returns:boolean

true if empty, false otherwise

Annotations

@Override

See Also

MessagePassingQueue#isEmpty()

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

newNode	back to summary
protected final LinkedQueueAtomicNode<E> newNode()

newNode	back to summary
protected final LinkedQueueAtomicNode<E> newNode(E e)

peek back to summary

peek	back to summary
public E peek() Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.peek, java.util.Queue.peek. Doc from io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.peek. Called from the consumer thread subject to the restrictions appropriate to the implementation and according to the `Queue#peek()` interface. IMPLEMENTATION NOTES: Peek is allowed from a SINGLE thread. Peek is potentially blocking here as the `Queue#peek()` does not allow returning `null` if the queue is not empty. This is very different from the original Vyukov guarantees. See `relaxedPeek()` for the original semantics. Poll reads the next node from the consumerNode and: If it is `null` AND the queue is empty return `null`, if queue is not empty spin wait for value to become visible. If it is not `null` return it's value. Returns:E a message from the queue if one is available, `null` iff empty Annotations @Override See Also `MessagePassingQueue#peek()`, `java.util.Queue#peek()`

public E peek()

Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.peek, java.util.Queue.peek.

Doc from io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.peek.

Called from the consumer thread subject to the restrictions appropriate to the implementation and according to the Queue#peek() interface.

IMPLEMENTATION NOTES:
Peek is allowed from a SINGLE thread.
Peek is potentially blocking here as the Queue#peek() does not allow returning null if the queue is not empty. This is very different from the original Vyukov guarantees. See relaxedPeek() for the original semantics.
Poll reads the next node from the consumerNode and:

If it is null AND the queue is empty return null, if queue is not empty spin wait for value to become visible.
If it is not null return it's value.

Returns:E

a message from the queue if one is available, null iff empty

Annotations

@Override

poll back to summary

poll	back to summary
public E poll() Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.poll, java.util.Queue.poll. Doc from io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.poll. Called from the consumer thread subject to the restrictions appropriate to the implementation and according to the `Queue#poll()` interface. IMPLEMENTATION NOTES: Poll is allowed from a SINGLE thread. Poll is potentially blocking here as the `Queue#poll()` does not allow returning `null` if the queue is not empty. This is very different from the original Vyukov guarantees. See `relaxedPoll()` for the original semantics. Poll reads `consumerNode.next` and: If it is `null` AND the queue is empty return `null`, if queue is not empty spin wait for value to become visible. If it is not `null` set it as the consumer node and return it's now evacuated value. This means the consumerNode.value is always `null`, which is also the starting point for the queue. Because `null` values are not allowed to be offered this is the only node with it's value set to `null` at any one time. Returns:E a message from the queue if one is available, `null` iff empty Annotations @Override See Also `MessagePassingQueue#poll()`, `java.util.Queue#poll()`

public E poll()

Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.poll, java.util.Queue.poll.

Doc from io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.poll.

Called from the consumer thread subject to the restrictions appropriate to the implementation and according to the Queue#poll() interface.

IMPLEMENTATION NOTES:
Poll is allowed from a SINGLE thread.
Poll is potentially blocking here as the Queue#poll() does not allow returning null if the queue is not empty. This is very different from the original Vyukov guarantees. See relaxedPoll() for the original semantics.
Poll reads consumerNode.next and:

If it is null AND the queue is empty return null, if queue is not empty spin wait for value to become visible.
If it is not null set it as the consumer node and return it's now evacuated value.

This means the consumerNode.value is always null, which is also the starting point for the queue. Because null values are not allowed to be offered this is the only node with it's value set to null at any one time.

Returns:E

a message from the queue if one is available, null iff empty

Annotations

@Override

relaxedOffer back to summary

relaxedOffer	back to summary
public boolean relaxedOffer(E e) Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.relaxedOffer. Doc from io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.relaxedOffer. 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. Parameters e:E not `null`, will throw NPE if it is Returns:boolean true if element was inserted into the queue, false if unable to offer Annotations @Override

public boolean relaxedOffer(E e)

Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.relaxedOffer.

Doc from io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.relaxedOffer.

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.

Parameters

e:E: not null, will throw NPE if it is

Returns:boolean

true if element was inserted into the queue, false if unable to offer

Annotations

@Override

relaxedPeek back to summary

relaxedPeek	back to summary
public E relaxedPeek() Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.relaxedPeek. Doc from io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.relaxedPeek. 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. Returns:E a message from the queue if one is available, `null` if unable to peek Annotations @Override

public E relaxedPeek()

Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.relaxedPeek.

Doc from io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.relaxedPeek.

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.

Returns:E

a message from the queue if one is available, null if unable to peek

Annotations

@Override

relaxedPoll back to summary

relaxedPoll	back to summary
public E relaxedPoll() Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.relaxedPoll. Doc from io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.relaxedPoll. 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. Returns:E a message from the queue if one is available, `null` if unable to poll Annotations @Override

public E relaxedPoll()

Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.relaxedPoll.

Doc from io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.relaxedPoll.

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.

Returns:E

a message from the queue if one is available, null if unable to poll

Annotations

@Override

size back to summary

size	back to summary
public final int size() Implements abstract java.util.AbstractCollection.size. Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.size, java.util.Collection.size. Doc from io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.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. For some implementations this method may be O(n) rather than O(1). Implementation Notes This is an O(n) operation as we run through all the nodes and count them. The accuracy of the value returned by this method is subject to races with producer/consumer threads. In particular when racing with the consumer thread this method may under estimate the size. Returns:int number of messages in the queue, between 0 and `Integer#MAX_VALUE` but less or equals to capacity (if bounded). Annotations @Override See Also `java.util.Queue#size()`

public final int size()

Implements abstract java.util.AbstractCollection.size.

Implements io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.size, java.util.Collection.size.

Doc from io.netty.util.internal.shaded.org.jctools.queues.MessagePassingQueue.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. For some implementations this method may be O(n) rather than O(1).

Implementation Notes

This is an O(n) operation as we run through all the nodes and count them.
The accuracy of the value returned by this method is subject to races with producer/consumer threads. In particular when racing with the consumer thread this method may under estimate the size.

Returns:int

number of messages in the queue, between 0 and Integer#MAX_VALUE but less or equals to capacity (if bounded).

Annotations

@Override

See Also

java.util.Queue#size()

spinWaitForNextNode	back to summary
pack-priv LinkedQueueAtomicNode<E> spinWaitForNextNode(LinkedQueueAtomicNode<E> currNode)

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 BaseLinkedAtomicQueue<E>

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail