org.opendaylight.vtn.manager.internal.util.tx

Class TxSyncFuture<T>

java.lang.Object

org.opendaylight.vtn.manager.internal.util.concurrent.AbstractVTNFuture<T>

org.opendaylight.vtn.manager.internal.util.tx.TxSyncFuture<T>

Type Parameters:

T - The type of the object to be returned by the specified MD-SAL transaction task.

All Implemented Interfaces:

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

public final class TxSyncFuture<T>
extends AbstractVTNFuture<T>

An implementation of VTNFuture used to wait for completion of all MD-SAL transaction tasks, including background tasks started by the target task.

This class returns the value returned by the specified MD-SAL transaction task. Note that this future returns a value as long as the specified MD-SAL transaction has successfully completed.

Cancellation of the target MD-SAL transaction task is not supported. cancel(boolean) only cancels a rendezvous with additional background tasks started by the target MD-SAL transaction task.

Constructor Summary

Constructors

Constructor and Description
TxSyncFuture(TxTask<T> task, VTNFuture<T> f) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	cancel(boolean intr) Attempt to cancel execution of the task.
T	get() Wait for the task to complete, and then return the result of the task.
T	get(long timeout, TimeUnit unit) Wait for the task to complete, and then return the result of the task.
boolean	isCancelled() Determine whether the task was canceled before it completed normally.
boolean	isDone() Determine whether the task completed or not.

Methods inherited from class org.opendaylight.vtn.manager.internal.util.concurrent.AbstractVTNFuture

addListener, done, getCause, getException

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.vtn.manager.internal.util.concurrent.VTNFuture

checkedGet, checkedGet

Constructor Detail

TxSyncFuture

public TxSyncFuture(TxTask<T> task,
                    VTNFuture<T> f)

Construct a new instance.

Parameters:

task - A TxTask instance.

f - A VTNFuture associated with task.

Method Detail

cancel

public boolean cancel(boolean intr)

Attempt to cancel execution of the task.

Note that this method cancels only a rendezvous with additional background tasks, and never cancels the target MD-SAL transaction task.

Parameters:

intr - Unused because this future is designed to run using callback.

Returns:

false is always returned because the target MD-SAL transaction task will never be canceled.

isCancelled

public boolean isCancelled()

Determine whether the task was canceled before it completed normally.

Returns:

false is always returned because the target MD-SAL transaction task will never be canceled.

isDone

public boolean isDone()

Determine whether the task completed or not.

Returns:

true only if the task completed.

get

public T get()
      throws InterruptedException,
             ExecutionException

Wait for the task to complete, and then return the result of the task.

Returns:

The result of the task.

Throws:

InterruptedException - The current thread was interrupted while waiting.

ExecutionException - The task caught an exception.

get

public T get(long timeout,
             TimeUnit unit)
      throws InterruptedException,
             ExecutionException,
             TimeoutException

Wait for the task to complete, and then return the result of the task.

Parameters:

timeout - The maximum time to wait

unit - The time unit of timeout.

Returns:

The result of the task.

Throws:

InterruptedException - The current thread was interrupted while waiting.

ExecutionException - The task caught an exception.

TimeoutException - The task did not complete within the given timeout.