net.lecousin.framework.concurrent.async

Class WaitingDataQueueSynchronizationPoint<DataType,TError extends Exception>

java.lang.Object

net.lecousin.framework.concurrent.async.AbstractLock<TError>

net.lecousin.framework.concurrent.async.WaitingDataQueueSynchronizationPoint<DataType,TError>

Type Parameters:

DataType - type of data in the queue

TError - type of error

All Implemented Interfaces:

Cancellable, IAsync<TError>

public class WaitingDataQueueSynchronizationPoint<DataType,TError extends Exception>
extends AbstractLock<TError>

Like a SynchronizationPoint, but with a queue of waiting data. If no data is available, it is considered as blocked, and any thread calling the method waitForData will be paused until a new data arrives in the pool. Each call to the method waitForData will return the next data, in the order they arrived in the queue.
When no more data will be added, the method endOfData can be called, so if any thread arrives, and no more data is available in the queue, the thread is not paused, and a null data is returned.

Field Summary

Fields inherited from class net.lecousin.framework.concurrent.async.AbstractLock

cancel, error, listeners

Constructor Summary

Constructors

Constructor and Description
WaitingDataQueueSynchronizationPoint()

Method Summary

Modifier and Type	Method and Description
void	block(long timeout) Pause the current thread to wait for this asynchronous unit to be unblocked.
boolean	blockPauseCondition() Return true if blockPause should still block.
void	endOfData() Signal that no more data will be queued, so any waiting thread can be unblocked.
boolean	isDone() Return true if unblocked (success or cancelled).
void	newDataReady(DataType data) Queue a new data, which may unblock a thread waiting for it.
void	onDone(Runnable listener) Call listener when unblocked (whatever the result is successful, has error or is cancelled).
protected void	unlock()
DataType	waitForData(long timeout) To call when data is needed.

Methods inherited from class net.lecousin.framework.concurrent.async.AbstractLock

cancel, error, getAllListeners, getCancelEvent, getError, hasError, isCancelled

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.lecousin.framework.concurrent.async.IAsync

blockException, blockPause, blockThrow, forwardIfNotSuccessful, isSuccessful, logListenerError, onCancel, onDone, onDone, onDone, onDone, onDone, onDone, onError, onErrorOrCancel, onSuccess, thenDoOrStart, thenDoOrStart, thenDoOrStart, thenStart, thenStart, thenStart, thenStart, thenStart, thenStart, toAsyncSupplier

Constructor Detail

WaitingDataQueueSynchronizationPoint

public WaitingDataQueueSynchronizationPoint()

Method Detail

waitForData

public DataType waitForData(long timeout)

To call when data is needed.

Returns:

the next data, or null if no more data will be available

newDataReady

public void newDataReady(DataType data)

Queue a new data, which may unblock a thread waiting for it.

endOfData

public void endOfData()

Signal that no more data will be queued, so any waiting thread can be unblocked.

isDone

public boolean isDone()

Description copied from interface: IAsync

Return true if unblocked (success or cancelled).

block

public void block(long timeout)

Description copied from interface: IAsync

Pause the current thread to wait for this asynchronous unit to be unblocked.

blockPauseCondition

public boolean blockPauseCondition()

Description copied from interface: IAsync

Return true if blockPause should still block.

onDone

public void onDone(Runnable listener)

Description copied from interface: IAsync

Call listener when unblocked (whatever the result is successful, has error or is cancelled).

unlock

protected void unlock()

Specified by:

unlock in class AbstractLock<TError extends Exception>