org.opendaylight.vtn.manager.internal.util.concurrent

Interface VTNFuture<T>

Type Parameters:

T - The type of the object to be returned.

All Superinterfaces:

com.google.common.util.concurrent.CheckedFuture<T,VTNException>, Future<T>, com.google.common.util.concurrent.ListenableFuture<T>

All Known Implementing Classes:

AbstractReadFlowFuture, AbstractVTNFuture, AddMdFlowTask, CanceledFuture, ClearNodeFlowsTask, FlowCountFuture, GetMacMappedHostFuture, GetVlanMapFuture, ReadDataFlowFuture, ReadFlowFuture, ReadSingleFlowFuture, RpcFuture, RunnableVTNFuture, SettableVTNFuture, TxSyncFuture, VTNFutureTask

public interface VTNFuture<T>
extends com.google.common.util.concurrent.CheckedFuture<T,VTNException>

A VTNFuture is a CheckedFuture that wraps exception in a VTNException.

Method Summary

Modifier and Type	Method and Description
default T	checkedGet() Wait for the computation to complete, and then return the result.
default T	checkedGet(long timeout, TimeUnit unit) Wait for the computation to complete within the given timeout, and then return the result.

Methods inherited from interface com.google.common.util.concurrent.ListenableFuture

addListener

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Method Detail

checkedGet

default T checkedGet()
              throws VTNException

Wait for the computation to complete, and then return the result.

An exception will be always wrapped by a VTNException.

Specified by:

checkedGet in interface com.google.common.util.concurrent.CheckedFuture<T,VTNException>

Returns:

The result of the computation.

Throws:

VTNException - An error occurred.

checkedGet

default T checkedGet(long timeout,
                     TimeUnit unit)
              throws VTNException

Wait for the computation to complete within the given timeout, and then return the result.

An exception will be always wrapped by a VTNException, including TimeoutException.

Specified by:

checkedGet in interface com.google.common.util.concurrent.CheckedFuture<T,VTNException>

Parameters:

timeout - The maximum time to wait.

unit - The time unit of timeout argument.

Returns:

The result of the computation.

Throws:

VTNException - An error occurred.