org.apache.flink.statefun.flink.core.queue

Class MpscQueue<T>

java.lang.Object

org.apache.flink.statefun.flink.core.queue.MpscQueue<T>

Type Parameters:

T - element type

@Internal
public final class MpscQueue<T>
extends java.lang.Object

Multi producers single consumer fifo queue.

This queue supports two operations:

• add(Object) atomically adds an element to this queue and returns the number of elements in the queue after the addition.
• drainAll() atomically obtains a snapshot of the queue and simultaneously empties the queue, i.e. drains it.

Constructor Summary

Constructors

Constructor and Description
MpscQueue(int initialBufferSize, Lock lock)

Method Summary

Modifier and Type	Method and Description
int	add(T element) Adds an element to this (unbound) queue.
java.util.Deque<T>	drainAll() Atomically drains the queue.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MpscQueue

public MpscQueue(int initialBufferSize,
                 Lock lock)

Method Detail

add

public int add(T element)

Adds an element to this (unbound) queue.

Parameters:

element - the element to add.

Returns:

the number of elements in the queue after the addition.

drainAll

public java.util.Deque<T> drainAll()

Atomically drains the queue.

Returns:

a batch of elements that obtained atomically from that queue.