Modifier and Type	Class and Description
pack-priv static class	MpscLinkedQueue.LinkedQueueNode<E>

Modifier and Type	Field and Description
private final AtomicReference<MpscLinkedQueue.LinkedQueueNode<T>>	consumerNode
private final AtomicReference<MpscLinkedQueue.LinkedQueueNode<T>>	producerNode

Access	Constructor and Description
public	MpscLinkedQueue()

Method Summary

Modifier and Type	Method and Description
public void	clear() Implements io.reactivex.internal.fuseable.SimpleQueue.clear. Removes all enqueued items from this queue.
public boolean	isEmpty() Implements io.reactivex.internal.fuseable.SimpleQueue.isEmpty. Returns true if the queue is empty.
pack-priv MpscLinkedQueue.LinkedQueueNode<T>	lpConsumerNode()
pack-priv MpscLinkedQueue.LinkedQueueNode<T>	lvConsumerNode()
pack-priv MpscLinkedQueue.LinkedQueueNode<T>	lvProducerNode()
public boolean	offer(final T the value to enqueue, not null e) Implements io.reactivex.internal.fuseable.SimpleQueue.offer. Atomically enqueue a single.
public boolean	offer(T the first value to enqueue, not null v1, T the second value to enqueue, not null v2) Implements io.reactivex.internal.fuseable.SimpleQueue.offer. Atomically enqueue two values.
public T	poll() Implements io.reactivex.internal.fuseable.SimplePlainQueue.poll. Tries to dequeue a value (non-null) or returns null if the queue is empty.
pack-priv void	spConsumerNode(MpscLinkedQueue.LinkedQueueNode<T> node)
pack-priv MpscLinkedQueue.LinkedQueueNode<T>	xchgProducerNode(MpscLinkedQueue.LinkedQueueNode<T> node)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

consumerNode	back to summary
private final AtomicReference<MpscLinkedQueue.LinkedQueueNode<T>> consumerNode

producerNode	back to summary
private final AtomicReference<MpscLinkedQueue.LinkedQueueNode<T>> producerNode

Constructor Detail

MpscLinkedQueue	back to summary
public MpscLinkedQueue()

Method Detail

clear	back to summary
public void clear() Implements io.reactivex.internal.fuseable.SimpleQueue.clear. Doc from io.reactivex.internal.fuseable.SimpleQueue.clear. Removes all enqueued items from this queue. Annotations @Override

clear

back to summary

public void clear()

Implements io.reactivex.internal.fuseable.SimpleQueue.clear.

Doc from io.reactivex.internal.fuseable.SimpleQueue.clear.

Removes all enqueued items from this queue.

Annotations

@Override

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Implements io.reactivex.internal.fuseable.SimpleQueue.isEmpty. Doc from io.reactivex.internal.fuseable.SimpleQueue.isEmpty. Returns true if the queue is empty. Note however that due to potential fused functions in `poll()` it is possible this method returns false but then poll() returns null because the fused function swallowed the available item(s). 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 the queue is empty Annotations @Override

public boolean isEmpty()

Implements io.reactivex.internal.fuseable.SimpleQueue.isEmpty.

Doc from io.reactivex.internal.fuseable.SimpleQueue.isEmpty.

Returns true if the queue is empty.

Note however that due to potential fused functions in poll() it is possible this method returns false but then poll() returns null because the fused function swallowed the available item(s).

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 the queue is empty

Annotations

@Override

lpConsumerNode	back to summary
pack-priv MpscLinkedQueue.LinkedQueueNode<T> lpConsumerNode()

lvConsumerNode	back to summary
pack-priv MpscLinkedQueue.LinkedQueueNode<T> lvConsumerNode()

lvProducerNode	back to summary
pack-priv MpscLinkedQueue.LinkedQueueNode<T> lvProducerNode()

offer back to summary

offer	back to summary
public boolean offer(final T e) Implements io.reactivex.internal.fuseable.SimpleQueue.offer. Doc from io.reactivex.internal.fuseable.SimpleQueue.offer. Atomically enqueue a single. 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 e:T the value to enqueue, not null Returns:boolean true if successful, false if the value was not enqueued likely due to reaching the queue capacity) Annotations @Override See Also `java.util.Queue#offer(java.lang.Object)`

public boolean offer(final T e)

Implements io.reactivex.internal.fuseable.SimpleQueue.offer.

Doc from io.reactivex.internal.fuseable.SimpleQueue.offer.

Atomically enqueue a single.

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

e:T: the value to enqueue, not null

Returns:boolean

true if successful, false if the value was not enqueued likely due to reaching the queue capacity)

Annotations

@Override

offer	back to summary
public boolean offer(T v1, T v2) Implements io.reactivex.internal.fuseable.SimpleQueue.offer. Doc from io.reactivex.internal.fuseable.SimpleQueue.offer. Atomically enqueue two values. Parameters v1:T the first value to enqueue, not null v2:T the second value to enqueue, not null Returns:boolean true if successful, false if the value was not enqueued likely due to reaching the queue capacity) Annotations @Override

offer

back to summary

public boolean offer(T v1, T v2)

Implements io.reactivex.internal.fuseable.SimpleQueue.offer.

Doc from io.reactivex.internal.fuseable.SimpleQueue.offer.

Atomically enqueue two values.

Parameters

v1:T: the first value to enqueue, not null
v2:T: the second value to enqueue, not null

Returns:boolean

true if successful, false if the value was not enqueued likely due to reaching the queue capacity)

Annotations

@Override

poll back to summary

poll	back to summary
public T poll() Implements io.reactivex.internal.fuseable.SimplePlainQueue.poll. Doc from io.reactivex.internal.fuseable.SimpleQueue.poll. Tries to dequeue a value (non-null) or returns null if the queue is empty. If the producer uses `offer(Object, Object)` and when polling in pairs, if the first poll() returns a non-null item, the second poll() is guaranteed to return a non-null item as well. 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:T the item or null to indicate an empty queue Annotations @Nullable @Override See Also `java.util.Queue#poll()`

public T poll()

Implements io.reactivex.internal.fuseable.SimplePlainQueue.poll.

Doc from io.reactivex.internal.fuseable.SimpleQueue.poll.

Tries to dequeue a value (non-null) or returns null if the queue is empty.

If the producer uses offer(Object, Object) and when polling in pairs, if the first poll() returns a non-null item, the second poll() is guaranteed to return a non-null item as well.

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:T

the item or null to indicate an empty queue

Annotations

@Nullable
@Override

See Also

java.util.Queue#poll()

spConsumerNode	back to summary
pack-priv void spConsumerNode(MpscLinkedQueue.LinkedQueueNode<T> node)

xchgProducerNode	back to summary
pack-priv MpscLinkedQueue.LinkedQueueNode<T> xchgProducerNode(MpscLinkedQueue.LinkedQueueNode<T> node)

io.reactivex.internal.queue back to summary

pack-priv final Class MpscLinkedQueue.LinkedQueueNode<E>

Class Inheritance

extends AtomicReference<MpscLinkedQueue.LinkedQueueNode<E>>

java.lang.Object
java.util.concurrent.atomic.AtomicReference
io.reactivex.internal.queue.MpscLinkedQueue.LinkedQueueNode

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides java.util.concurrent.atomic.AtomicReference.serialVersionUID.
private E	value Hides java.util.concurrent.atomic.AtomicReference.value.

Constructor Summary

Access	Constructor and Description
pack-priv	LinkedQueueNode()
pack-priv	LinkedQueueNode(E val)

Method Summary

Modifier and Type	Method and Description
public E	Returns: value getAndNullValue() Gets the current value and nulls out the reference to it from this node.
public E	lpValue()
public MpscLinkedQueue.LinkedQueueNode<E>	lvNext()
public void	soNext(MpscLinkedQueue.LinkedQueueNode<E> n)
public void	spValue(E newValue)

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.util.concurrent.atomic.AtomicReference.serialVersionUID.

value	back to summary
private E value Hides java.util.concurrent.atomic.AtomicReference.value.

Constructor Detail

LinkedQueueNode	back to summary
pack-priv LinkedQueueNode()

LinkedQueueNode	back to summary
pack-priv LinkedQueueNode(E val)

Method Detail

getAndNullValue	back to summary
public E getAndNullValue() Gets the current value and nulls out the reference to it from this node. Returns:E value

getAndNullValue

back to summary

public E getAndNullValue()

Gets the current value and nulls out the reference to it from this node.

Returns:E: value

lpValue	back to summary
public E lpValue()

lvNext	back to summary
public MpscLinkedQueue.LinkedQueueNode<E> lvNext()

soNext	back to summary
public void soNext(MpscLinkedQueue.LinkedQueueNode<E> n)

spValue	back to summary
public void spValue(E newValue)

public final Class MpscLinkedQueue<T>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class MpscLinkedQueue.LinkedQueueNode<E>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail