org.michailov.async

Class AsyncAgent

java.lang.Object

org.michailov.async.AsyncAgent

Direct Known Subclasses:

AsyncByteStreamReader, AsyncByteStreamWriter, AsyncCharDecoder, AsyncCharEncoder, AsyncLineJoiner, AsyncLineSplitter, AsyncRingBufferWatcher, AsyncTextStreamReader, AsyncTextStreamWriter

public abstract class AsyncAgent
extends java.lang.Object

Abstract functionality that encapsulates context in which WhenReady patterns are called. This is a convenience base class for classes that perform async operations.

See Also:

WhenReady

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AsyncAgent(AsyncOptions asyncOptions) Base constructor for derived classes to call.

Method Summary

Modifier and Type	Method and Description
protected void	action() The 'action' function passed to WhenReady.applyAsync(java.util.function.Predicate<S>, java.util.function.Function<S, R>, S) or WhenReady.startApplyLoopAsync(java.util.function.Predicate<S>, java.util.function.Predicate<S>, java.util.function.Function<S, R>, S).
java.util.concurrent.CompletableFuture<java.lang.Void>	applyAsync() Starts a new WhenReady.applyAsync(java.util.function.Predicate<S>, java.util.function.Function<S, R>, S) operation.
protected boolean	done() The 'done' predicate passed to WhenReady.startApplyLoopAsync(java.util.function.Predicate<S>, java.util.function.Predicate<S>, java.util.function.Function<S, R>, S).
boolean	isIdle() Checks whether this AsyncAgent is idle, i.e.
protected boolean	ready() The 'ready' predicate passed to WhenReady.completeAsync(java.util.function.Predicate<S>, R, S), WhenReady.applyAsync(java.util.function.Predicate<S>, java.util.function.Function<S, R>, S), or WhenReady.startApplyLoopAsync(java.util.function.Predicate<S>, java.util.function.Predicate<S>, java.util.function.Function<S, R>, S).
protected void	setIdle() Marks this agent as 'idle'.
protected void	setIdleAndThrow(java.lang.Throwable ex) Throws an AsyncException to notify the WhenReady framework that something has gone wrong.
java.util.concurrent.CompletableFuture<java.lang.Void>	startApplyLoopAsync() Starts a new WhenReady.startApplyLoopAsync(java.util.function.Predicate<S>, java.util.function.Predicate<S>, java.util.function.Function<S, R>, S) operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncAgent

protected AsyncAgent(AsyncOptions asyncOptions)

Base constructor for derived classes to call.

Parameters:

asyncOptions - AsyncOptions that will control all async operations on this agent.

Method Detail

applyAsync

public java.util.concurrent.CompletableFuture<java.lang.Void> applyAsync()

Starts a new WhenReady.applyAsync(java.util.function.Predicate<S>, java.util.function.Function<S, R>, S) operation.

Returns:

A future that will get completed with the result returned from action() when the ready() predicate returns true.

startApplyLoopAsync

public java.util.concurrent.CompletableFuture<java.lang.Void> startApplyLoopAsync()

Starts a new WhenReady.startApplyLoopAsync(java.util.function.Predicate<S>, java.util.function.Predicate<S>, java.util.function.Function<S, R>, S) operation.

Returns:

A future that will get completed with the result returned from the last execution of action().

ready

protected boolean ready()

The 'ready' predicate passed to WhenReady.completeAsync(java.util.function.Predicate<S>, R, S), WhenReady.applyAsync(java.util.function.Predicate<S>, java.util.function.Function<S, R>, S), or WhenReady.startApplyLoopAsync(java.util.function.Predicate<S>, java.util.function.Predicate<S>, java.util.function.Function<S, R>, S).

Returns:

Derived classes should override this method to return true iff it is time to execute action().

done

protected boolean done()

The 'done' predicate passed to WhenReady.startApplyLoopAsync(java.util.function.Predicate<S>, java.util.function.Predicate<S>, java.util.function.Function<S, R>, S).

Returns:

Derived classes should override this method to return true iff it is time for the loop to stop.

action

protected void action()

The 'action' function passed to WhenReady.applyAsync(java.util.function.Predicate<S>, java.util.function.Function<S, R>, S) or WhenReady.startApplyLoopAsync(java.util.function.Predicate<S>, java.util.function.Predicate<S>, java.util.function.Function<S, R>, S).

Derived classes should override this method.

isIdle

public boolean isIdle()

Checks whether this AsyncAgent is idle, i.e. whether it can accept requests for async operations.

Returns:

true iff this AsyncAgent is idle.

setIdle

protected void setIdle()

Marks this agent as 'idle'.

setIdleAndThrow

protected void setIdleAndThrow(java.lang.Throwable ex)

Throws an AsyncException to notify the WhenReady framework that something has gone wrong. Marks this agent as 'idle'.

Parameters:

ex - An exception to complete with.