com.ea.orbit.async

Class Await

java.lang.Object

com.ea.orbit.async.Await

public class Await
extends Object

In methods annotated with @Async calls to await(future) will cause the method to return a CompletableFuture (or Task) instead of blocking.

This is equivalent to use CompletableFuture composition methods (ex: thenApply, handle). The advantage of using await is that the code will resemble sequential blocking code.

Example:

 import com.ea.orbit.async.Async;
 import static com.ea.orbit.async.Await.await;
 ...

 Async
 CompletableFuture getPageLengthAsync()
 {
     CompletableFuture pageFuture = getPageAsync("http://example.com");
     String page = await(pageFuture);
     return CompletableFuture.completedFuture(page.length);
 }

Or using orbit Task:

 Async
 Task CompletableFuture getPageLengthAsync()
 {
     Task pageFuture = getPageAsync("http://example.com");
     String page = await(pageFuture);
     return Task.fromValue(page.length);
 }

Caveat: The following code must be called before the program execution: static { Await.init() } Otherwise, the first method to call await() might be blocking, and a warning message will be printed to the console. Subsequent async methods will work as expected.

Constructor Summary

Constructors

Constructor and Description
Await()

Method Summary

Modifier and Type	Method and Description
static <T> T	await(CompletableFuture<T> future) Calls to this method are replaced by the orbit-async instrumentation.
static void	init()

Methods inherited from class java.lang.Object

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

Constructor Detail

Await

public Await()

Method Detail

init

public static void init()

await

public static <T> T await(CompletableFuture<T> future)

Calls to this method are replaced by the orbit-async instrumentation.

Type Parameters:

T - the return type of future.join()

Parameters:

future - a future to wait for.

Returns:

the return value of the future