com.couchbase.lite.support

Class Batcher<T>

java.lang.Object

com.couchbase.lite.support.Batcher<T>

public class Batcher<T>
extends java.lang.Object

Utility that queues up objects until the queue fills up or a time interval elapses, then passes objects, in groups of its capacity, to a client-supplied processor block.

Constructor Summary

Constructors

Constructor and Description
Batcher(java.util.concurrent.ScheduledExecutorService workExecutor, int capacity, long delay, BatchProcessor<T> processor) Initializes a batcher.

Method Summary

Modifier and Type	Method and Description
void	clear() Empties the queue without processing any of the objects in it.
int	count() The number of objects currently in the queue.
void	flushAll(boolean waitForAllToFinish) Sends _all_ the queued objects at once to the processor block.
void	flushAllAndWait()
int	getCapacity() Get capacity amount.
long	getDelay() Get delay amount.
boolean	isEmpty()
void	queueObject(T object) Adds an object to the queue.
void	queueObjects(java.util.List<T> objects) Adds multiple objects to the queue.
void	waitForPendingFutures() Wait for the **current** items in the queue to be all processed.

Methods inherited from class java.lang.Object

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

Constructor Detail

Batcher

public Batcher(java.util.concurrent.ScheduledExecutorService workExecutor,
               int capacity,
               long delay,
               BatchProcessor<T> processor)

Initializes a batcher.

Parameters:

workExecutor - the work executor that performs actual work

capacity - The maximum number of objects to batch up. If the queue reaches this size, the queued objects will be sent to the processor immediately.

delay - The maximum waiting time in milliseconds to collect objects before processing them. In some circumstances objects will be processed sooner.

processor - The callback/block that will be called to process the objects.

Method Detail

getCapacity

public int getCapacity()

Get capacity amount.

getDelay

public long getDelay()

Get delay amount.

isEmpty

public boolean isEmpty()

count

public int count()

The number of objects currently in the queue.

queueObject

public void queueObject(T object)

Adds an object to the queue.

queueObjects

public void queueObjects(java.util.List<T> objects)

Adds multiple objects to the queue.

flushAllAndWait

public void flushAllAndWait()

flushAll

public void flushAll(boolean waitForAllToFinish)

Sends _all_ the queued objects at once to the processor block. After this method returns, all inbox objects will be processed.

Parameters:

waitForAllToFinish - wait until all objects are processed. If set to True, need to make sure not to call flushAll in the same WorkExecutor used by the batcher as it will result to deadlock.

clear

public void clear()

Empties the queue without processing any of the objects in it.

waitForPendingFutures

public void waitForPendingFutures()

Wait for the **current** items in the queue to be all processed. Note: Calling this method on the same thread as the WorkExecutor set to the batcher will result to deadlock.