Additional top-level classes in compilation unit: SpscAtomicArrayQueueColdField, SpscAtomicArrayQueueL1Pad, SpscAtomicArrayQueueProducerIndexFields, SpscAtomicArrayQueueL2Pad, SpscAtomicArrayQueueConsumerIndexField, SpscAtomicArrayQueueL3Pad.
Note
This class was automatically generated by io.netty.util.internal.shaded.org.jctools.queues.atomic.JavaParsingAtomicArrayQueueGenerator which can found in the jctools-build module. The original source file is SpscArrayQueue.java. A Single-Producer-Single-Consumer queue backed by a pre-allocated buffer.
This implementation is a mashup of the Fast Flow
algorithm with an optimization of the offer method taken from the BQueue algorithm (a variation on Fast
Flow), and adjusted to comply with Queue.offer semantics with regards to capacity.
For convenience the relevant papers are available in the `resources` folder:
2010 - Pisa - SPSC Queues on Shared Cache Multi-Core Systems.pdf
2012 - Junchang- BQueue- Efficient and Practical Queuing.pdf
This implementation is wait free.
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public int | drain(final MessagePassingQueue.
Implements io. |
| public int | drain(final MessagePassingQueue.
Implements io. |
| public void | drain(final MessagePassingQueue.
Implements io. |
| public int | fill(final MessagePassingQueue.
Implements io. |
| public int | fill(final MessagePassingQueue.
Implements io. |
| public void | fill(final MessagePassingQueue.
Implements io. |
| public boolean | offer(final E
not e)null, will throw NPE if it isImplements io. Queue#offer(Object) interface.
|
| private boolean | |
| public E | peek()
Implements io. Queue#peek() interface.
|
| public E | poll()
Implements io. Queue#poll() interface.
|
| public boolean | relaxedOffer(final E
not message)null, will throw NPE if it isImplements io. |
| public E | relaxedPeek()
Implements io. |
| public E | relaxedPoll()
Implements io. |
| SpscAtomicArrayQueue | back to summary |
|---|---|
| public SpscAtomicArrayQueue(final int capacity) | |
| drain | back to summary |
|---|---|
| public int drain(final MessagePassingQueue. Implements io. Doc from io. 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
| |
| drain | back to summary |
|---|---|
| public int drain(final MessagePassingQueue. Implements io. Doc from io. Remove up to limit elements from the queue and hand to consume. This should be semantically similar to:
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
| |
| drain | back to summary |
|---|---|
| public void drain(final MessagePassingQueue. Implements io. Doc from io. 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
| |
| fill | back to summary |
|---|---|
| public int fill(final MessagePassingQueue. Implements io. Doc from io. 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
| |
| fill | back to summary |
|---|---|
| public int fill(final MessagePassingQueue. Implements io. Doc from io. Stuff the queue with up to limit elements from the supplier. Semantically similar to:
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 Warning Explicit assumptions are made with regards to
| |
| fill | back to summary |
|---|---|
| public void fill(final MessagePassingQueue. Implements io. Doc from io. Stuff the queue with elements from the supplier forever. Semantically similar to:
Called from a producer thread subject to the restrictions appropriate to the implementation. The main difference
being that implementors MUST assure room in the queue is available BEFORE calling Warning Explicit assumptions are made with regards to
| |
| offer | back to summary |
|---|---|
| public boolean offer(final E e) Implements io. Doc from io. Called from a producer thread subject to the restrictions appropriate to the implementation and
according to the This implementation is correct for single producer thread use only.
| |
| offerSlowPath | back to summary |
|---|---|
| private boolean offerSlowPath(final AtomicReferenceArray<E> buffer, final int mask, final long producerIndex) | |
| peek | back to summary |
|---|---|
| public E peek() Implements io. Doc from io. Called from the consumer thread subject to the restrictions appropriate to the implementation and
according to the This implementation is correct for single consumer thread use only.
| |
| poll | back to summary |
|---|---|
| public E poll() Implements io. Doc from io. Called from the consumer thread subject to the restrictions appropriate to the implementation and
according to the This implementation is correct for single consumer thread use only.
| |
| relaxedOffer | back to summary |
|---|---|
| public boolean relaxedOffer(final E message) Implements io. Doc from io. Called from a producer thread subject to the restrictions appropriate to the implementation. As opposed
to
| |
| relaxedPeek | back to summary |
|---|---|
| public E relaxedPeek() Implements io. Doc from io. Called from the consumer thread subject to the restrictions appropriate to the implementation. As
opposed to
| |
| relaxedPoll | back to summary |
|---|---|
| public E relaxedPoll() Implements io. Doc from io. Called from the consumer thread subject to the restrictions appropriate to the implementation. As
opposed to
| |