com.scaleoutsoftware.soss.client.da

Interface StateServerFuture<V>

Type Parameters:

V - the type of the StateServerResult returned via Future.get() operations.

All Superinterfaces:

java.util.concurrent.Future<V>, ListenableFuture<V>

public interface StateServerFuture<V>
extends ListenableFuture<V>

A Future specialization allowing DataAccessor clients to retrieve the result of an asynchronous StateServer request. StateServerFuture provides methods for unwrapping the ExecutionExceptions thrown from Future.get() and Future.get(long, TimeUnit) as StateServerExceptions.

See Also:

Future

Method Summary

Modifier and Type	Method and Description
V	getWithExceptionUnwrap() Waits if necessary for the computation to complete, and then retrieves its result.
V	getWithExceptionUnwrap(long timeout, java.util.concurrent.TimeUnit unit) Waits if necessary for the computation to complete, and then retrieves its result.

Methods inherited from interface com.scaleoutsoftware.soss.client.da.ListenableFuture

addListener, removeListener

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Method Detail

getWithExceptionUnwrap

V getWithExceptionUnwrap()
                  throws StateServerException

Waits if necessary for the computation to complete, and then retrieves its result. Any Exceptions are unwrapped/wrapped as necessary and thrown as StateServerExceptions.

This method wraps Future.get(). If Future.get() throws an ExecutionException, this method examines Throwable.getCause(). If the cause is a StateServerException, the StateServerException is thrown. If the cause is a RuntimeException or Error the cause is thrown. Otherwise, if cause resulted from an I/O operation in sending or receiving the message and is wrapped as a StateServerChannelException and thrown.

Returns:

the computed result

Throws:

StateServerException - if the StateServer request resulted in an exception.

See Also:

Future.get()

getWithExceptionUnwrap

V getWithExceptionUnwrap(long timeout,
                         java.util.concurrent.TimeUnit unit)
                  throws StateServerException,
                         java.util.concurrent.TimeoutException

Waits if necessary for the computation to complete, and then retrieves its result. Any Exceptions are unwrapped/wrapped as necessary and thrown as StateServerExceptions.

This method wraps Future.get(). If Future.get() throws an ExecutionException, this method examines Throwable.getCause(). If the cause is a StateServerException, the StateServerException is thrown. If the cause is a RuntimeException or Error the cause is thrown. Otherwise, cause resulted from the I/O operation in sending or receiving the message and is wrapped as a StateServerChannelException and thrown.

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

the computed result

Throws:

StateServerException - if the StateServer request resulted in an exception.

java.util.concurrent.TimeoutException - if the timeout expired before the operation was completed.

See Also:

Future.get(long, TimeUnit)