Package org.apache.bookkeeper.common.collections

Class BlockingMpscQueue<T>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

org.jctools.queues.MpscArrayQueue<T>

org.apache.bookkeeper.common.collections.BlockingMpscQueue<T>

All Implemented Interfaces:

Iterable<T>, Collection<T>, BlockingQueue<T>, Queue<T>, BatchedBlockingQueue<T>, org.jctools.queues.IndexedQueueSizeUtil.IndexedQueue, org.jctools.queues.MessagePassingQueue<T>, org.jctools.queues.QueueProgressIndicators, org.jctools.queues.SupportsIterator

public class BlockingMpscQueue<T>
extends org.jctools.queues.MpscArrayQueue<T>
implements BlockingQueue<T>, BatchedBlockingQueue<T>

Blocking queue optimized for multiple producers and single consumer.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jctools.queues.MessagePassingQueue

org.jctools.queues.MessagePassingQueue.Consumer<T extends Object>, org.jctools.queues.MessagePassingQueue.ExitCondition, org.jctools.queues.MessagePassingQueue.Supplier<T extends Object>, org.jctools.queues.MessagePassingQueue.WaitStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected final T[]	buffer
protected final long	mask

Fields inherited from interface org.jctools.queues.MessagePassingQueue

UNBOUNDED_CAPACITY

Constructor Summary

Constructors

Constructor	Description
BlockingMpscQueue(int size)

Method Summary

Modifier and Type	Method	Description
int	capacity()
void	clear()
long	currentConsumerIndex()
long	currentProducerIndex()
int	drainTo(Collection<? super T> c)
int	drainTo(Collection<? super T> c, int maxElements)
boolean	isEmpty()
Iterator<T>	iterator()
final long	lvConsumerIndex()
final long	lvProducerIndex()
boolean	offer(T e, long timeout, TimeUnit unit)
T	poll(long timeout, TimeUnit unit)
int	pollAll(T[] array, long timeout, TimeUnit unit)	Removes multiple items from the queue.
void	put(T e)
void	putAll(T[] a, int offset, int len)
int	remainingCapacity()
int	size()
T	take()
int	takeAll(T[] array)	Drain the queue into an array.
String	toString()

Methods inherited from class org.jctools.queues.MpscArrayQueue

drain, drain, drain, failFastOffer, fill, fill, fill, offer, offerIfBelowThreshold, peek, poll, relaxedOffer, relaxedPeek, relaxedPoll

Methods inherited from class java.util.AbstractQueue

add, addAll, element, remove

Methods inherited from class java.util.AbstractCollection

contains, containsAll, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.BlockingQueue

add, contains, offer, remove

Methods inherited from interface java.util.Collection

addAll, clear, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Queue

element, peek, poll, remove

Field Details

mask

protected final long mask

buffer

protected final T[] buffer

Constructor Details

BlockingMpscQueue

public BlockingMpscQueue(int size)

Method Details

put

public void put(T e)
         throws InterruptedException

Specified by:

put in interface BlockingQueue<T>

Throws:

InterruptedException

offer

public boolean offer(T e,
 long timeout,
 TimeUnit unit)
              throws InterruptedException

Specified by:

offer in interface BlockingQueue<T>

Throws:

InterruptedException

take

public T take()
       throws InterruptedException

Specified by:

take in interface BlockingQueue<T>

Throws:

InterruptedException

poll

public T poll(long timeout,
 TimeUnit unit)
       throws InterruptedException

Specified by:

poll in interface BlockingQueue<T>

Throws:

InterruptedException

remainingCapacity

public int remainingCapacity()

Specified by:

remainingCapacity in interface BlockingQueue<T>

drainTo

public int drainTo(Collection<? super T> c)

Specified by:

drainTo in interface BlockingQueue<T>

drainTo

public int drainTo(Collection<? super T> c,
 int maxElements)

Specified by:

drainTo in interface BlockingQueue<T>

putAll

public void putAll(T[] a,
 int offset,
 int len)
            throws InterruptedException

Specified by:

putAll in interface BatchedBlockingQueue<T>

Throws:

InterruptedException

takeAll

public int takeAll(T[] array)
            throws InterruptedException

Description copied from interface: BatchedBlockingQueue

Drain the queue into an array. Wait if there are no items in the queue.

Specified by:

takeAll in interface BatchedBlockingQueue<T>

Returns:

Throws:

InterruptedException

pollAll

public int pollAll(T[] array,
 long timeout,
 TimeUnit unit)
            throws InterruptedException

Description copied from interface: BatchedBlockingQueue

Removes multiple items from the queue. The method returns when either: 1. At least one item is available 2. The timeout expires

Specified by:

pollAll in interface BatchedBlockingQueue<T>

Returns:

Throws:

InterruptedException

lvConsumerIndex

public final long lvConsumerIndex()

lvProducerIndex

public final long lvProducerIndex()

size

public int size()

Specified by:

size in interface Collection<E extends Object>

Specified by:

size in interface org.jctools.queues.MessagePassingQueue<E extends Object>

Specified by:

size in class AbstractCollection<E extends Object>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E extends Object>

Specified by:

isEmpty in interface org.jctools.queues.MessagePassingQueue<E extends Object>

Overrides:

isEmpty in class AbstractCollection<E extends Object>

toString

public String toString()

Overrides:

toString in class AbstractCollection<E extends Object>

clear

public void clear()

Specified by:

clear in interface Collection<E extends Object>

Specified by:

clear in interface org.jctools.queues.MessagePassingQueue<E extends Object>

Overrides:

clear in class AbstractQueue<E extends Object>

capacity

public int capacity()

Specified by:

capacity in interface org.jctools.queues.IndexedQueueSizeUtil.IndexedQueue

Specified by:

capacity in interface org.jctools.queues.MessagePassingQueue<E extends Object>

currentProducerIndex

public long currentProducerIndex()

Specified by:

currentProducerIndex in interface org.jctools.queues.QueueProgressIndicators

currentConsumerIndex

public long currentConsumerIndex()

Specified by:

currentConsumerIndex in interface org.jctools.queues.QueueProgressIndicators

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Collection<E extends Object>

Specified by:

iterator in interface Iterable<E extends Object>

Specified by:

iterator in class AbstractCollection<E extends Object>