gololang.concurrent.async

Interface Future

All Known Implementing Classes:

AssignedFuture

public interface Future

A future is an abstraction over the eventual result of a possibly asynchronous computation. This interface is intended to be used in conjunction with Promise. A future is a read-only view over a promise. Future objects are made composable in Golo through a set of augmentations: filter, map, etc. You should consult the "golodoc" of the gololang.Async module.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Future.Observer Simple interface for a future observer / callback.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	blockingGet() Blocking get, waiting until the future has been resolved.
java.lang.Object	get() Non-blocking get.
boolean	isFailed() Test whether the future has failed.
boolean	isResolved() Test whether the future has been resolved, that is, the future is either set or failed.
Future	onFail(Future.Observer observer) Registers a callback for when the future fails.
Future	onSet(Future.Observer observer) Registers a callback for when the future is set.

Method Detail

get

java.lang.Object get()

Non-blocking get.

Returns:

the future value, which may be null if it has not been resolved yet.

blockingGet

java.lang.Object blockingGet()
                      throws java.lang.InterruptedException

Blocking get, waiting until the future has been resolved.

Returns:

the future value.

Throws:

java.lang.InterruptedException - when the current thread is being interrupted.

isResolved

boolean isResolved()

Test whether the future has been resolved, that is, the future is either set or failed.

Returns:

true if the future is resolved, false otherwise.

isFailed

boolean isFailed()

Test whether the future has failed.

Returns:

true if the future is resolved and failed, false otherwise.

onSet

Future onSet(Future.Observer observer)

Registers a callback for when the future is set. If the future has already been set, then it is executed immediately from the caller thread.

Parameters:

observer - the callback.

Returns:

this future object.

onFail

Future onFail(Future.Observer observer)

Registers a callback for when the future fails. If the future has already been failed, then it is executed immediately from the caller thread.

Parameters:

observer - the callback.

Returns:

this future object.