org.apache.reef.vortex.api

Class VortexFuture<TOutput>

java.lang.Object

org.apache.reef.vortex.api.VortexFuture<TOutput>

All Implemented Interfaces:

Future<TOutput>, VortexFutureDelegate<TOutput>

public final class VortexFuture<TOutput>
extends Object
implements Future<TOutput>, VortexFutureDelegate<TOutput>

The interface between user code and submitted task.

Constructor Summary

Constructors

Constructor and Description
VortexFuture(Executor executor, VortexMaster vortexMaster, int taskletId) Creates a VortexFuture.
VortexFuture(Executor executor, VortexMaster vortexMaster, int taskletId, FutureCallback<TOutput> callbackHandler) Creates a VortexFuture with a callback.

Method Summary

Methods

Modifier and Type	Method and Description
void	aggregationCompleted(List<Integer> taskletIds, TOutput result) VortexMaster should never call this.
void	aggregationThrewException(List<Integer> taskletIds, Exception exception) VortexMaster should never call this.
boolean	cancel(boolean mayInterruptIfRunning) Sends a cancel signal and blocks and waits until the task is cancelled, completed, or failed.
boolean	cancel(boolean mayInterruptIfRunning, long timeout, TimeUnit unit) Sends a cancel signal and blocks and waits until the task is cancelled, completed, or failed, or if the timeout has expired.
void	cancelled(int pTaskletId) Called by VortexMaster to let the user know that the Tasklet was cancelled.
void	completed(int pTaskletId, TOutput result) Called by VortexMaster to let the user know that the Tasklet completed.
TOutput	get() Infinitely wait for the result of the task.
TOutput	get(long timeout, TimeUnit unit) Wait a certain period of time for the result of the task.
boolean	isCancelled()
boolean	isDone()
void	threwException(int pTaskletId, Exception exception) Called by VortexMaster to let the user know that the Tasklet threw an exception.

Methods inherited from class java.lang.Object

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

Constructor Detail

VortexFuture

public VortexFuture(Executor executor,
            VortexMaster vortexMaster,
            int taskletId)

Creates a VortexFuture.

VortexFuture

public VortexFuture(Executor executor,
            VortexMaster vortexMaster,
            int taskletId,
            FutureCallback<TOutput> callbackHandler)

Creates a VortexFuture with a callback.

Method Detail

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Sends a cancel signal and blocks and waits until the task is cancelled, completed, or failed.

Specified by:

cancel in interface Future<TOutput>

Returns:

true if task did not start or was cancelled, false if task failed or completed

cancel

public boolean cancel(boolean mayInterruptIfRunning,
             long timeout,
             TimeUnit unit)
               throws TimeoutException

Sends a cancel signal and blocks and waits until the task is cancelled, completed, or failed, or if the timeout has expired.

Returns:

true if task did not start or was cancelled, false if task failed or completed

Throws:

TimeoutException

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<TOutput>

Returns:

true if the task is cancelled, false if not.

isDone

public boolean isDone()

Specified by:

isDone in interface Future<TOutput>

Returns:

true it the task completed, false if not.

get

public TOutput get()
            throws InterruptedException,
                   ExecutionException,
                   CancellationException

Infinitely wait for the result of the task.

Specified by:

get in interface Future<TOutput>

Throws:

InterruptedException - if the thread is interrupted.

ExecutionException - if the Tasklet execution failed to complete.

CancellationException - if the Tasklet was cancelled.

get

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

Wait a certain period of time for the result of the task.

Specified by:

get in interface Future<TOutput>

Throws:

TimeoutException - if the timeout provided hits before the Tasklet is done.

InterruptedException - if the thread is interrupted.

ExecutionException - if the Tasklet execution failed to complete.

CancellationException - if the Tasklet was cancelled.

completed

public void completed(int pTaskletId,
             TOutput result)

Called by VortexMaster to let the user know that the Tasklet completed.

Specified by:

completed in interface VortexFutureDelegate<TOutput>

aggregationCompleted

public void aggregationCompleted(List<Integer> taskletIds,
                        TOutput result)

VortexMaster should never call this.

Specified by:

aggregationCompleted in interface VortexFutureDelegate<TOutput>

threwException

public void threwException(int pTaskletId,
                  Exception exception)

Called by VortexMaster to let the user know that the Tasklet threw an exception.

Specified by:

threwException in interface VortexFutureDelegate<TOutput>

aggregationThrewException

public void aggregationThrewException(List<Integer> taskletIds,
                             Exception exception)

VortexMaster should never call this.

Specified by:

aggregationThrewException in interface VortexFutureDelegate<TOutput>

cancelled

public void cancelled(int pTaskletId)

Called by VortexMaster to let the user know that the Tasklet was cancelled.

Specified by:

cancelled in interface VortexFutureDelegate<TOutput>