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

Class FutureCanceller<T>

java.lang.Object

java.util.TimerTask

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

Type Parameters:

T - The type of the result returned by the target task.

All Implemented Interfaces:

com.google.common.util.concurrent.FutureCallback<T>, Runnable

public final class FutureCanceller<T>
extends TimerTask
implements com.google.common.util.concurrent.FutureCallback<T>

An implementation of Runnable that cancels the task associated with the given ListenableFuture instance.

Method Summary

Modifier and Type	Method and Description
void	onFailure(Throwable cause) Invoked when the taret task has failed.
void	onSuccess(T result) Invoked when the target task has successfully completed.
void	run() Cancel the specified task.
static <T> void	set(Timer timer, long timeout, com.google.common.util.concurrent.ListenableFuture<T> f) Set a future canceller that cancels the given future without interrupting the thread.
static <T> void	set(Timer timer, long timeout, com.google.common.util.concurrent.ListenableFuture<T> f, boolean intr) Set a future canceller that cancels the given future.

Methods inherited from class java.util.TimerTask

cancel, scheduledExecutionTime

Methods inherited from class java.lang.Object

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

Method Detail

set

public static <T> void set(Timer timer,
                           long timeout,
                           com.google.common.util.concurrent.ListenableFuture<T> f)

Set a future canceller that cancels the given future without interrupting the thread.

Type Parameters:

T - The type of the result returned by the target task.

Parameters:

timer - A Timer instance to execute the timer.

timeout - The number of milliseconds to wait for completion of the target task.

f - A ListenableFuture instance associated with the task to wait.

set

public static <T> void set(Timer timer,
                           long timeout,
                           com.google.common.util.concurrent.ListenableFuture<T> f,
                           boolean intr)

Set a future canceller that cancels the given future.

Type Parameters:

T - The type of the result returned by the target task.

Parameters:

timer - A Timer instance to execute the timer.

timeout - The number of milliseconds to wait for completion of the target task.

f - A ListenableFuture instance associated with the task to wait.

intr - true if the task runner thread should be interrupted. Otherwise in-progress task are allowed to complete.

run

public void run()

Cancel the specified task.

Specified by:

run in interface Runnable

Specified by:

run in class TimerTask

onSuccess

public void onSuccess(T result)

Invoked when the target task has successfully completed.

This method only cancels this timer task.

Specified by:

onSuccess in interface com.google.common.util.concurrent.FutureCallback<T>

Parameters:

result - The result of the target task.

onFailure

public void onFailure(Throwable cause)

Invoked when the taret task has failed.

This method only cancels this timer task.

Specified by:

onFailure in interface com.google.common.util.concurrent.FutureCallback<T>

Parameters:

cause - A Throwable that indicates the cause of failure.