org.apache.ratis.util

Class DataQueue<E>

java.lang.Object

org.apache.ratis.util.DataQueue<E>

All Implemented Interfaces:

Iterable<E>

Direct Known Subclasses:

DataBlockingQueue

public class DataQueue<E>
extends Object
implements Iterable<E>

A queue for data elements such that the queue imposes limits on both number of elements and the data size in bytes. Null element is NOT supported. This class is NOT threadsafe.

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor and Description
DataQueue(Object name, SizeInBytes byteLimit, int elementLimit, ToLongFunction<E> getNumBytes)

Method Summary

Modifier and Type	Method and Description
void	clear() The same as Collection.clear().
long	getByteLimit()
int	getElementLimit()
long	getNumBytes()
int	getNumElements()
boolean	isEmpty() The same as Collection.isEmpty().
Iterator<E>	iterator()
boolean	offer(E element) Adds an element to this queue.
E	poll() Poll out the head element from this queue.
<RESULT,THROWABLE extends Throwable> List<RESULT>	pollList(long timeoutMs, CheckedFunctionWithTimeout<E,RESULT,THROWABLE> getResult, TriConsumer<E,TimeDuration,TimeoutException> timeoutHandler) Poll a list of the results within the given timeout.
boolean	remove(E e) The same as Collection.remove(Object).

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

LOG

public static final org.slf4j.Logger LOG

Constructor Detail

DataQueue

public DataQueue(Object name,
                 SizeInBytes byteLimit,
                 int elementLimit,
                 ToLongFunction<E> getNumBytes)

Method Detail

getElementLimit

public int getElementLimit()

getByteLimit

public long getByteLimit()

getNumBytes

public long getNumBytes()

getNumElements

public int getNumElements()

isEmpty

public final boolean isEmpty()

The same as Collection.isEmpty().

clear

public void clear()

The same as Collection.clear().

offer

public boolean offer(E element)

Adds an element to this queue.

Returns:

true if the element is added successfully; otherwise, the element is not added, return false.

pollList

public <RESULT,THROWABLE extends Throwable> List<RESULT> pollList(long timeoutMs,
                                                                  CheckedFunctionWithTimeout<E,RESULT,THROWABLE> getResult,
                                                                  TriConsumer<E,TimeDuration,TimeoutException> timeoutHandler)
                                                           throws THROWABLE extends Throwable

Poll a list of the results within the given timeout.

Throws:

THROWABLE extends Throwable

poll

public E poll()

Poll out the head element from this queue.

remove

public boolean remove(E e)

The same as Collection.remove(Object).

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>