eu.toolchain.async

Class TinyAsync

java.lang.Object

eu.toolchain.async.TinyAsync

All Implemented Interfaces:

AsyncFramework

public class TinyAsync
extends Object
implements AsyncFramework

Entry point to the tiny async framework.

Example usage

TinyAsync async = TinyAsync.builder().caller(new Slf4jCaller()).build(); final ResolvableFuture<Integer> future = async.future() someAsyncOperation(future); future.on(new FutureDone<Integer>() { void resolved(Integer result) { // hurray } void failed(Throwable cause) { // nay :( } });

Field Summary

Fields

Modifier and Type	Field and Description
protected static Collector<? extends Object,? extends Collection<? extends Object>>	collectCollector
protected LazyTransform<? extends AsyncFuture<?>,?>	lazyCallTransform

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TinyAsync(ExecutorService defaultExecutor, AsyncCaller caller, AsyncCaller threadedCaller, ScheduledExecutorService scheduler, ClockSource clockSource)

Method Summary

Modifier and Type	Method and Description
protected <T> void	bindSignals(AsyncFuture<T> target, Collection<? extends AsyncFuture<?>> futures) Bind the given collection of futures to the target future, which if cancelled, or failed will do the corresponding to their collection of futures.
static TinyAsyncBuilder	builder() Build a new TinyAsync instance.
<C> AsyncFuture<C>	call(Callable<? extends C> callable)
<C> AsyncFuture<C>	call(Callable<? extends C> callable, ExecutorService executor)
<C> AsyncFuture<C>	call(Callable<? extends C> callable, ExecutorService executor, ResolvableFuture<C> future)
AsyncCaller	caller()
<T> AsyncFuture<T>	cancelled()
<T> AsyncFuture<T>	cancelled(AsyncFuture<T> future, LazyTransform<Void,? extends T> transform)
<T> AsyncFuture<T>	cancelled(AsyncFuture<T> future, Transform<Void,? extends T> transform)
<C,T> AsyncFuture<T>	collect(Collection<? extends AsyncFuture<? extends C>> futures, Collector<? super C,? extends T> collector)
<C,T> AsyncFuture<T>	collect(Collection<? extends AsyncFuture<? extends C>> futures, StreamCollector<? super C,? extends T> collector)
<T> AsyncFuture<Collection<T>>	collect(Collection<? extends AsyncFuture<? extends T>> futures)
<C> AsyncFuture<Void>	collectAndDiscard(Collection<? extends AsyncFuture<C>> futures)
protected <T> Collector<T,Collection<T>>	collection()
ExecutorService	defaultExecutor() Fetch the configured primary executor (if any).
protected <C,T> AsyncFuture<T>	doCollect(Collection<? extends AsyncFuture<? extends C>> futures, Collector<? super C,? extends T> collector)
protected <T,C> AsyncFuture<T>	doCollect(Collection<? extends AsyncFuture<? extends C>> futures, StreamCollector<? super C,? extends T> collector)
protected <C> AsyncFuture<Void>	doCollectAndDiscard(Collection<? extends AsyncFuture<C>> futures)
protected <C,T> AsyncFuture<T>	doCollectEmpty(Collector<C,? extends T> collector) Shortcut for when the list of futures is empty.
protected <C,T> AsyncFuture<T>	doCollectEmpty(StreamCollector<? super C,? extends T> collector) Shortcut for when the list of futures is empty with StreamCollector.
protected <T,C> AsyncFuture<T>	doEventuallyCollect(Collection<? extends Callable<? extends AsyncFuture<? extends C>>> callables, StreamCollector<? super C,? extends T> collector, int parallelism)
protected <T,C> AsyncFuture<T>	doEventuallyCollectEmpty(StreamCollector<? super C,? extends T> collector)
protected <C,T> AsyncFuture<T>	doEventuallyCollectImmediate(Collection<? extends Callable<? extends AsyncFuture<? extends C>>> callables, StreamCollector<? super C,? extends T> collector)
<T> AsyncFuture<T>	error(AsyncFuture<T> future, LazyTransform<Throwable,? extends T> transform)
<T> AsyncFuture<T>	error(AsyncFuture<T> future, Transform<Throwable,? extends T> transform)
<C,T> AsyncFuture<T>	eventuallyCollect(Collection<? extends Callable<? extends AsyncFuture<? extends C>>> callables, StreamCollector<? super C,? extends T> collector, int parallelism)
<T> AsyncFuture<T>	failed(Throwable e)
<T> ResolvableFuture<T>	future()
<T> AsyncFuture<T>	lazyCall(Callable<? extends AsyncFuture<T>> callable)
<T> AsyncFuture<T>	lazyCall(Callable<? extends AsyncFuture<T>> callable, ExecutorService executor)
protected <T> LazyTransform<AsyncFuture<T>,T>	lazyCallTransform()
<C> Managed<C>	managed(ManagedSetup<C> setup)
<C> ReloadableManaged<C>	reloadableManaged(ManagedSetup<C> setup)
AsyncFuture<Void>	resolved()
<T> AsyncFuture<T>	resolved(T value)
<T> AsyncFuture<RetryResult<T>>	retryUntilResolved(Callable<? extends AsyncFuture<? extends T>> action, RetryPolicy policy)
<T> AsyncFuture<RetryResult<T>>	retryUntilResolved(Callable<? extends AsyncFuture<? extends T>> action, RetryPolicy policy, ClockSource clockSource)
AsyncCaller	threadedCaller()
<C,T> AsyncFuture<T>	transform(AsyncFuture<C> future, LazyTransform<? super C,? extends T> transform)
<C,T> AsyncFuture<T>	transform(AsyncFuture<C> future, Transform<? super C,? extends T> transform)

Methods inherited from class java.lang.Object

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

Field Detail

lazyCallTransform

protected final LazyTransform<? extends AsyncFuture<?>,?> lazyCallTransform

collectCollector

protected static final Collector<? extends Object,? extends Collection<? extends Object>> collectCollector

Constructor Detail

TinyAsync

protected TinyAsync(ExecutorService defaultExecutor,
                    AsyncCaller caller,
                    AsyncCaller threadedCaller,
                    ScheduledExecutorService scheduler,
                    ClockSource clockSource)

Method Detail

defaultExecutor

public ExecutorService defaultExecutor()

Fetch the configured primary executor (if any).

Returns:

The configured primary executor.

Throws:

IllegalStateException - if no caller executor is available.

threadedCaller

public AsyncCaller threadedCaller()

Specified by:

threadedCaller in interface AsyncFramework

caller

public AsyncCaller caller()

Specified by:

caller in interface AsyncFramework

transform

public <C,T> AsyncFuture<T> transform(AsyncFuture<C> future,
                                      Transform<? super C,? extends T> transform)

Specified by:

transform in interface AsyncFramework

transform

public <C,T> AsyncFuture<T> transform(AsyncFuture<C> future,
                                      LazyTransform<? super C,? extends T> transform)

Specified by:

transform in interface AsyncFramework

error

public <T> AsyncFuture<T> error(AsyncFuture<T> future,
                                Transform<Throwable,? extends T> transform)

Specified by:

error in interface AsyncFramework

error

public <T> AsyncFuture<T> error(AsyncFuture<T> future,
                                LazyTransform<Throwable,? extends T> transform)

Specified by:

error in interface AsyncFramework

cancelled

public <T> AsyncFuture<T> cancelled(AsyncFuture<T> future,
                                    Transform<Void,? extends T> transform)

Specified by:

cancelled in interface AsyncFramework

cancelled

public <T> AsyncFuture<T> cancelled(AsyncFuture<T> future,
                                    LazyTransform<Void,? extends T> transform)

Specified by:

cancelled in interface AsyncFramework

call

public <C> AsyncFuture<C> call(Callable<? extends C> callable)

Specified by:

call in interface AsyncFramework

lazyCall

public <T> AsyncFuture<T> lazyCall(Callable<? extends AsyncFuture<T>> callable)

Specified by:

lazyCall in interface AsyncFramework

call

public <C> AsyncFuture<C> call(Callable<? extends C> callable,
                               ExecutorService executor)

Specified by:

call in interface AsyncFramework

lazyCall

public <T> AsyncFuture<T> lazyCall(Callable<? extends AsyncFuture<T>> callable,
                                   ExecutorService executor)

Specified by:

lazyCall in interface AsyncFramework

lazyCallTransform

protected <T> LazyTransform<AsyncFuture<T>,T> lazyCallTransform()

call

public <C> AsyncFuture<C> call(Callable<? extends C> callable,
                               ExecutorService executor,
                               ResolvableFuture<C> future)

Specified by:

call in interface AsyncFramework

future

public <T> ResolvableFuture<T> future()

Specified by:

future in interface AsyncFramework

resolved

public AsyncFuture<Void> resolved()

Specified by:

resolved in interface AsyncFramework

resolved

public <T> AsyncFuture<T> resolved(T value)

Specified by:

resolved in interface AsyncFramework

failed

public <T> AsyncFuture<T> failed(Throwable e)

Specified by:

failed in interface AsyncFramework

cancelled

public <T> AsyncFuture<T> cancelled()

Specified by:

cancelled in interface AsyncFramework

collect

public <T> AsyncFuture<Collection<T>> collect(Collection<? extends AsyncFuture<? extends T>> futures)

Specified by:

collect in interface AsyncFramework

collect

public <C,T> AsyncFuture<T> collect(Collection<? extends AsyncFuture<? extends C>> futures,
                                    Collector<? super C,? extends T> collector)

Specified by:

collect in interface AsyncFramework

doCollect

protected <C,T> AsyncFuture<T> doCollect(Collection<? extends AsyncFuture<? extends C>> futures,
                                         Collector<? super C,? extends T> collector)

doCollectEmpty

protected <C,T> AsyncFuture<T> doCollectEmpty(Collector<C,? extends T> collector)

Shortcut for when the list of futures is empty.

collect

public <C,T> AsyncFuture<T> collect(Collection<? extends AsyncFuture<? extends C>> futures,
                                    StreamCollector<? super C,? extends T> collector)

Specified by:

collect in interface AsyncFramework

doCollect

protected <T,C> AsyncFuture<T> doCollect(Collection<? extends AsyncFuture<? extends C>> futures,
                                         StreamCollector<? super C,? extends T> collector)

eventuallyCollect

public <C,T> AsyncFuture<T> eventuallyCollect(Collection<? extends Callable<? extends AsyncFuture<? extends C>>> callables,
                                              StreamCollector<? super C,? extends T> collector,
                                              int parallelism)

Specified by:

eventuallyCollect in interface AsyncFramework

collection

protected <T> Collector<T,Collection<T>> collection()

doEventuallyCollectEmpty

protected <T,C> AsyncFuture<T> doEventuallyCollectEmpty(StreamCollector<? super C,? extends T> collector)

doEventuallyCollectImmediate

protected <C,T> AsyncFuture<T> doEventuallyCollectImmediate(Collection<? extends Callable<? extends AsyncFuture<? extends C>>> callables,
                                                            StreamCollector<? super C,? extends T> collector)

doEventuallyCollect

protected <T,C> AsyncFuture<T> doEventuallyCollect(Collection<? extends Callable<? extends AsyncFuture<? extends C>>> callables,
                                                   StreamCollector<? super C,? extends T> collector,
                                                   int parallelism)

doCollectEmpty

protected <C,T> AsyncFuture<T> doCollectEmpty(StreamCollector<? super C,? extends T> collector)

Shortcut for when the list of futures is empty with StreamCollector.

collectAndDiscard

public <C> AsyncFuture<Void> collectAndDiscard(Collection<? extends AsyncFuture<C>> futures)

Specified by:

collectAndDiscard in interface AsyncFramework

doCollectAndDiscard

protected <C> AsyncFuture<Void> doCollectAndDiscard(Collection<? extends AsyncFuture<C>> futures)

managed

public <C> Managed<C> managed(ManagedSetup<C> setup)

Specified by:

managed in interface AsyncFramework

reloadableManaged

public <C> ReloadableManaged<C> reloadableManaged(ManagedSetup<C> setup)

Specified by:

reloadableManaged in interface AsyncFramework

builder

public static TinyAsyncBuilder builder()

Build a new TinyAsync instance.

Returns:

A builder for the TinyAsync instance.

bindSignals

protected <T> void bindSignals(AsyncFuture<T> target,
                               Collection<? extends AsyncFuture<?>> futures)

Bind the given collection of futures to the target future, which if cancelled, or failed will do the corresponding to their collection of futures.

Parameters:

target - The future to cancel, and fail on.

futures - The futures to cancel, when target is cancelled.

retryUntilResolved

public <T> AsyncFuture<RetryResult<T>> retryUntilResolved(Callable<? extends AsyncFuture<? extends T>> action,
                                                          RetryPolicy policy)

Specified by:

retryUntilResolved in interface AsyncFramework

retryUntilResolved

public <T> AsyncFuture<RetryResult<T>> retryUntilResolved(Callable<? extends AsyncFuture<? extends T>> action,
                                                          RetryPolicy policy,
                                                          ClockSource clockSource)

Specified by:

retryUntilResolved in interface AsyncFramework