org.apache.reef.vortex.api

Class VortexAggregateFuture<TInput,TOutput>

java.lang.Object

org.apache.reef.vortex.api.VortexAggregateFuture<TInput,TOutput>

All Implemented Interfaces:

VortexFutureDelegate

@NotThreadSafe
public final class VortexAggregateFuture<TInput,TOutput>
extends Object
implements VortexFutureDelegate

The interface between user code and aggregation Tasklets. Thread safety: This class is not meant to be used in a multi-threaded fashion. TODO[JIRA REEF-1131]: Create and run tests once functional.

Constructor Summary

Constructors

Constructor and Description
VortexAggregateFuture(Executor executor, Map<Integer,TInput> taskletIdInputMap, Codec<TOutput> aggOutputCodec, FutureCallback<AggregateResult<TInput,TOutput>> callbackHandler)

Method Summary

Methods

Modifier and Type	Method and Description
void	aggregationCompleted(List<Integer> taskletIds, byte[] serializedResult) Aggregation has completed for a list of Tasklets, with an aggregated result.
void	aggregationThrewException(List<Integer> taskletIds, Exception exception) A list of Tasklets has failed during aggregation phase.
void	cancelled(int taskletId) Not implemented for local aggregation.
void	completed(int taskletId, byte[] serializedResult) A Tasklet associated with the aggregation has completed.
AggregateResultSynchronous<TInput,TOutput>	get()
AggregateResultSynchronous<TInput,TOutput>	get(long timeout, TimeUnit timeUnit)
boolean	isDone()
void	threwException(int taskletId, Exception exception) A Tasklet associated with the aggregation has failed.

Methods inherited from class java.lang.Object

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

Constructor Detail

VortexAggregateFuture

public VortexAggregateFuture(Executor executor,
                     Map<Integer,TInput> taskletIdInputMap,
                     Codec<TOutput> aggOutputCodec,
                     FutureCallback<AggregateResult<TInput,TOutput>> callbackHandler)

Method Detail

get

public AggregateResultSynchronous<TInput,TOutput> get()
                                               throws InterruptedException

Returns:

the next aggregation result for the future, null if no more results.

Throws:

InterruptedException

get

public AggregateResultSynchronous<TInput,TOutput> get(long timeout,
                                             TimeUnit timeUnit)
                                               throws InterruptedException,
                                                      TimeoutException

Parameters:

timeout - the timeout for the operation.

timeUnit - the time unit of the timeout.

Returns:

the next aggregation result for the future, within the user specified timeout, null if no more results.

Throws:

TimeoutException - if time out hits.

InterruptedException

isDone

public boolean isDone()

Returns:

true if there are no more results to poll.

completed

public void completed(int taskletId,
             byte[] serializedResult)

A Tasklet associated with the aggregation has completed.

Specified by:

completed in interface VortexFutureDelegate

aggregationCompleted

public void aggregationCompleted(List<Integer> taskletIds,
                        byte[] serializedResult)

Aggregation has completed for a list of Tasklets, with an aggregated result.

Specified by:

aggregationCompleted in interface VortexFutureDelegate

threwException

public void threwException(int taskletId,
                  Exception exception)

A Tasklet associated with the aggregation has failed.

Specified by:

threwException in interface VortexFutureDelegate

aggregationThrewException

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

A list of Tasklets has failed during aggregation phase.

Specified by:

aggregationThrewException in interface VortexFutureDelegate

cancelled

public void cancelled(int taskletId)

Not implemented for local aggregation.

Specified by:

cancelled in interface VortexFutureDelegate