net.lecousin.framework.concurrent.util

Class LimitAsyncOperations<InputType,OutputResultType,OutputErrorType extends Exception>

java.lang.Object

net.lecousin.framework.concurrent.util.LimitAsyncOperations<InputType,OutputResultType,OutputErrorType>

Type Parameters:

InputType - input data

OutputResultType - output result

OutputErrorType - error

Direct Known Subclasses:

LimitWriteOperations

public class LimitAsyncOperations<InputType,OutputResultType,OutputErrorType extends Exception>
extends Object

This class allows to queue asynchronous operations, but blocks if too many are waiting. This can typically used in operations receiving data, and writing to an IO, when the amount of data can be large: if we receive more data than the write operations can do, and we need to avoid having too much buffers in memory waiting to write.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LimitAsyncOperations.Executor<InputType,OutputResultType,OutputErrorType extends Exception> Executor of write operation.

Constructor Summary

Constructors

Constructor and Description
LimitAsyncOperations(int maxOperations, LimitAsyncOperations.Executor<InputType,OutputResultType,OutputErrorType> executor) Constructor.

Method Summary

Modifier and Type	Method and Description
IAsync<OutputErrorType>	flush() Same as getLastPendingOperation but never return null (return an unblocked synchronization point instead).
AsyncSupplier<OutputResultType,OutputErrorType>	getLastPendingOperation() Return the last pending operation, or null.
AsyncSupplier<OutputResultType,OutputErrorType>	write(InputType data) Queue the data to write.
protected void	writeDone(InputType data, AsyncSupplier<OutputResultType,OutputErrorType> result)

Methods inherited from class java.lang.Object

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

Constructor Detail

LimitAsyncOperations

public LimitAsyncOperations(int maxOperations,
                            LimitAsyncOperations.Executor<InputType,OutputResultType,OutputErrorType> executor)

Constructor.

Method Detail

write

public AsyncSupplier<OutputResultType,OutputErrorType> write(InputType data)
                                                      throws IOException

Queue the data to write. If there is no pending write, the write operation is started. If too many write operations are pending, the method is blocking.

Parameters:

data - the data to write.

Throws:

IOException

writeDone

protected void writeDone(InputType data,
                         AsyncSupplier<OutputResultType,OutputErrorType> result)

getLastPendingOperation

public AsyncSupplier<OutputResultType,OutputErrorType> getLastPendingOperation()

Return the last pending operation, or null.

flush

public IAsync<OutputErrorType> flush()

Same as getLastPendingOperation but never return null (return an unblocked synchronization point instead).