Package io.streamthoughts.azkarra.api.events

Class BasicBlockingRecordQueue<K,V>

java.lang.Object

io.streamthoughts.azkarra.api.events.BasicBlockingRecordQueue<K,V>

Type Parameters:

K - the record-key type.

V - the record-value type.

All Implemented Interfaces:

BlockingRecordQueue<K,V>

public class BasicBlockingRecordQueue<K,V>
extends Object
implements BlockingRecordQueue<K,V>

A simple BlockingRecordQueue backed by a BlockingQueue.

Since:

0.8.0

Constructor Summary

Constructors

Constructor	Description
BasicBlockingRecordQueue()	Creates a new BasicBlockingRecordQueue instance.
BasicBlockingRecordQueue(int queueSizeLimit)	Creates a new BasicBlockingRecordQueue instance.
BasicBlockingRecordQueue(int queueSizeLimit, Duration maxBlockDuration)	Creates a new BasicBlockingRecordQueue instance.
BasicBlockingRecordQueue(int queueSizeLimit, Duration maxBlockDuration, LimitHandler limitHandler)	Creates a new BasicBlockingRecordQueue instance.

Method Summary

Modifier and Type	Method	Description
void	clear()
void	close()	Close the queue.
void	drainTo(Collection<? super KV<K,V>> collection)
boolean	isEmpty()
void	open()	Open the queue.
KV<K,V>	poll()
KV<K,V>	poll(Duration timeout)
void	send(KV<K,V> record)	Sends a key-value record into this queue.
void	setLimitHandler(LimitHandler limitHandler)	Sets the handler to be invoked when the limit queue is reached.
void	setQueueCallback(QueueCallback callback)	Sets the callback to be executed when a new record is queued or the queue is closed.
int	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicBlockingRecordQueue

public BasicBlockingRecordQueue()

Creates a new BasicBlockingRecordQueue instance.

BasicBlockingRecordQueue

public BasicBlockingRecordQueue(int queueSizeLimit)

Creates a new BasicBlockingRecordQueue instance.

Parameters:

queueSizeLimit - the queue max capacity.

BasicBlockingRecordQueue

public BasicBlockingRecordQueue(int queueSizeLimit,
                                Duration maxBlockDuration)

Creates a new BasicBlockingRecordQueue instance.

Parameters:

queueSizeLimit - the queue max capacity.

maxBlockDuration - the maximum duration to wait to wait before giving up, when the queue is full.

BasicBlockingRecordQueue

public BasicBlockingRecordQueue(int queueSizeLimit,
                                Duration maxBlockDuration,
                                LimitHandler limitHandler)

Creates a new BasicBlockingRecordQueue instance.

Parameters:

queueSizeLimit - the blocking size limit;

maxBlockDuration - the maximum duration to wait to wait before giving up, when the queue is full.

limitHandler - the LimitHandler to invoke after maxBlockDuration has been reached.

Method Detail

setLimitHandler

public void setLimitHandler(LimitHandler limitHandler)

Sets the handler to be invoked when the limit queue is reached.

Specified by:

setLimitHandler in interface BlockingRecordQueue<K,V>

Parameters:

limitHandler - the LimitHandler instance.

setQueueCallback

public void setQueueCallback(QueueCallback callback)

Sets the callback to be executed when a new record is queued or the queue is closed.

Specified by:

setQueueCallback in interface BlockingRecordQueue<K,V>

Parameters:

callback - the QueueCallback to execute.

poll

public KV<K,V> poll(Duration timeout)
                   throws InterruptedException

Specified by:

poll in interface BlockingRecordQueue<K,V>

Throws:

InterruptedException

See Also:

BlockingQueue.poll(long, TimeUnit)

poll

public KV<K,V> poll()

Specified by:

poll in interface BlockingRecordQueue<K,V>

See Also:

Queue.poll()

drainTo

public void drainTo(Collection<? super KV<K,V>> collection)

Specified by:

drainTo in interface BlockingRecordQueue<K,V>

See Also:

BlockingQueue.drainTo(Collection)

size

public int size()

Specified by:

size in interface BlockingRecordQueue<K,V>

Returns:

the number of records queued.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface BlockingRecordQueue<K,V>

Returns:

true if the queue is empty.

open

public void open()

Open the queue.

Specified by:

open in interface BlockingRecordQueue<K,V>

close

public void close()

Close the queue. The records sent after the queue is closed will be ignored.

Specified by:

close in interface BlockingRecordQueue<K,V>

send

public void send(KV<K,V> record)

Sends a key-value record into this queue.

Specified by:

send in interface BlockingRecordQueue<K,V>

Parameters:

record - the KV record.

clear

public void clear()

Specified by:

clear in interface BlockingRecordQueue<K,V>

See Also:

Collection.clear()