rxjava 1.3.8 · rx.internal.util.unsafe.MpscLinkedQueue

Access	Constructor and Description
public	MpscLinkedQueue()

Method Summary

Modifier and Type	Method and Description
public boolean	offer(final E the element to add nextValue) Implements java.util.Queue.offer. Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions.
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.
protected LinkedQueueNode<E>	xchgProducerNode(LinkedQueueNode<E> newVal)

Inherited from rx.internal.util.unsafe.BaseLinkedQueue:: isEmpty iterator size

MpscLinkedQueue	back to summary
public MpscLinkedQueue()

Method Detail

offer back to summary

offer	back to summary
public boolean offer(final E nextValue) 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. IMPLEMENTATION NOTES: Offer is allowed from multiple threads. Offer allocates a new node and: Swaps it atomically with current producer node (only one producer 'wins') Sets the new node as the node following from the swapped producer node This works because each producer is guaranteed to 'plant' a new node and link the old node. No 2 producers can get the same producer node as part of XCHG guarantee. Parameters nextValue:E the element to add Returns:boolean `true` if the element was added to this queue, else `false` Annotations @Override See Also `MessagePassingQueue#offer(Object)`, `java.util.Queue#offer(java.lang.Object)`

public boolean offer(final E nextValue)

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.

IMPLEMENTATION NOTES:
Offer is allowed from multiple threads.
Offer allocates a new node and:

Swaps it atomically with current producer node (only one producer 'wins')
Sets the new node as the node following from the swapped producer node

This works because each producer is guaranteed to 'plant' a new node and link the old node. No 2 producers can get the same producer node as part of XCHG guarantee.

Parameters

nextValue:E: the element to add

Returns:boolean

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

Annotations

@Override

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. Returns:E the head of this queue, or `null` if this queue is empty Annotations @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.

Returns:E

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

Annotations

@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. IMPLEMENTATION NOTES: Poll is allowed from a SINGLE thread. Poll reads the next node from the consumerNode and: If it is null, the queue is assumed empty (though it might not be). 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 the head of this queue, or `null` if this queue is empty Annotations @Override See Also `MessagePassingQueue#poll()`, `java.util.Queue#poll()`

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.

IMPLEMENTATION NOTES:
Poll is allowed from a SINGLE thread.
Poll reads the next node from the consumerNode and:

If it is null, the queue is assumed empty (though it might not be).
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

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

Annotations

@Override

xchgProducerNode	back to summary
protected LinkedQueueNode<E> xchgProducerNode(LinkedQueueNode<E> newVal) Annotations @SuppressWarnings:unchecked

public final Class MpscLinkedQueue<E>

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail