eu.toolchain.async

Class TinyAsyncBuilder

java.lang.Object

eu.toolchain.async.TinyAsyncBuilder

public class TinyAsyncBuilder
extends Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TinyAsyncBuilder()

Method Summary

Modifier and Type	Method and Description
TinyAsync	build()
TinyAsyncBuilder	caller(AsyncCaller caller) Specify an asynchronous caller implementation.
TinyAsyncBuilder	callerExecutor(ExecutorService callerExecutor) Specify a separate executor to use for caller (internal handle) invocation.
TinyAsyncBuilder	clockSource(ClockSource clockSource)
TinyAsyncBuilder	executor(ExecutorService executor) Configure the default executor to use for caller invocation,and asynchronous tasks submitted through AsyncFramework.call(Callable).
TinyAsyncBuilder	maxRecursionDepth(long maxRecursionDepth) Configure how many recursions should be allowed.
TinyAsyncBuilder	recursionSafe(boolean recursionSafe) Configure that all caller invocations should use a recursion safe mechanism.
TinyAsyncBuilder	scheduler(ScheduledExecutorService scheduler) Specify a scheduler to use with the built TinyAsync instance.
TinyAsyncBuilder	threaded(boolean threaded) Configure that all caller invocation, and async tasks should be using a thread pool.

Methods inherited from class java.lang.Object

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

Constructor Detail

TinyAsyncBuilder

protected TinyAsyncBuilder()

Method Detail

threaded

public TinyAsyncBuilder threaded(boolean threaded)

Configure that all caller invocation, and async tasks should be using a thread pool.

This will cause the configuration of TinyTask to throw an exception if an executor service is not available for all purposes.

Parameters:

threaded - Set true if all tasks should be executed on a thread pool, false otherwise.

Returns:

This builder.

recursionSafe

public TinyAsyncBuilder recursionSafe(boolean recursionSafe)

Configure that all caller invocations should use a recursion safe mechanism. In the normal case this doesn't change the behaviour of caller and threadedCaller, but when deep recursion is detected in the current thread the next recursive call is deferred to a separate thread.

Recursion is tracked for all threads that call the AsyncCallers.

This will make even the non-threaded caller use a thread in the case of deep recursion.

Parameters:

recursionSafe - Set true if all caller invocations should be done with a recursion safe mechanism, false otherwise.

Returns:

This builder.

maxRecursionDepth

public TinyAsyncBuilder maxRecursionDepth(long maxRecursionDepth)

Configure how many recursions should be allowed. This implies enabling recursionSafe.

Parameters:

maxRecursionDepth - The max number of times that a caller may go through AsyncCaller in a single thread.

Returns:

This builder.

caller

public TinyAsyncBuilder caller(AsyncCaller caller)

Specify an asynchronous caller implementation.

The 'caller' defines how handles are invoked. The simplest implementations are based of DirectAsyncCaller , which causes the call to be performed directly in the calling thread.

Parameters:

caller -

Returns:

This builder.

executor

public TinyAsyncBuilder executor(ExecutorService executor)

Configure the default executor to use for caller invocation,and asynchronous tasks submitted through AsyncFramework.call(Callable).

Parameters:

executor - Executor to use.

Returns:

This builder.

callerExecutor

public TinyAsyncBuilder callerExecutor(ExecutorService callerExecutor)

Specify a separate executor to use for caller (internal handle) invocation.

Implies use of threaded caller.

Parameters:

callerExecutor - Executor to use for callers.

Returns:

This builder.

scheduler

public TinyAsyncBuilder scheduler(ScheduledExecutorService scheduler)

Specify a scheduler to use with the built TinyAsync instance.

Parameters:

scheduler - The scheduler to use.

Returns:

This builder.

clockSource

public TinyAsyncBuilder clockSource(ClockSource clockSource)

build

public TinyAsync build()