org.apache.reef.driver.evaluator

Interface AllocatedEvaluator

All Superinterfaces:

AutoCloseable, ContextAndTaskSubmittable, ContextSubmittable, Identifiable, TaskSubmittable

public interface AllocatedEvaluator
extends AutoCloseable, Identifiable, ContextSubmittable, ContextAndTaskSubmittable, TaskSubmittable

Represents an Evaluator that is allocated, but is not running yet.

Method Summary

Methods

Modifier and Type	Method and Description
void	addFile(File file) Puts the given file into the working directory of the Evaluator.
void	addLibrary(File file) Puts the given file into the working directory of the Evaluator and adds it to its classpath.
void	close() Releases the allocated evaluator back to the resource manager.
EvaluatorDescriptor	getEvaluatorDescriptor()
void	setType(EvaluatorType type) Set the type of Evaluator to be instantiated.
void	submitContext(Configuration contextConfiguration) Submit a Context.
void	submitContextAndService(Configuration contextConfiguration, Configuration serviceConfiguration) Submit a Context and a Service Configuration.
void	submitContextAndServiceAndTask(Configuration contextConfiguration, Configuration serviceConfiguration, Configuration taskConfiguration) Subkit a Context with Services and a Task.
void	submitContextAndTask(Configuration contextConfiguration, Configuration taskConfiguration) Submit a Context and a Task.
void	submitTask(Configuration taskConfiguration) Submits the given Task for execution.

Methods inherited from interface org.apache.reef.io.naming.Identifiable

getId

Method Detail

addFile

void addFile(File file)

Puts the given file into the working directory of the Evaluator.

Parameters:

file - the file to be copied

Throws:

IOException - if the copy fails.

addLibrary

void addLibrary(File file)

Puts the given file into the working directory of the Evaluator and adds it to its classpath.

Parameters:

file - the file to be copied

Throws:

IOException - if the copy fails.

getEvaluatorDescriptor

EvaluatorDescriptor getEvaluatorDescriptor()

Returns:

the evaluator descriptor of this evaluator.

setType

void setType(EvaluatorType type)

Set the type of Evaluator to be instantiated. Defaults to EvaluatorType.JVM.

Parameters:

type -

close

void close()

Releases the allocated evaluator back to the resource manager.

Specified by:

close in interface AutoCloseable

submitTask

void submitTask(Configuration taskConfiguration)

Submits the given Task for execution.

This generates a ContextConfiguration for the root context with a generated ID derived from the EvaluatorId.

Specified by:

submitTask in interface TaskSubmittable

Parameters:

taskConfiguration - the Configuration. See TaskConfiguration for details.

submitContext

void submitContext(Configuration contextConfiguration)

Description copied from interface: ContextSubmittable

Submit a Context.

Specified by:

submitContext in interface ContextSubmittable

Parameters:

contextConfiguration - the Configuration of the EvaluatorContext. See ContextConfiguration for details.

submitContextAndService

void submitContextAndService(Configuration contextConfiguration,
                           Configuration serviceConfiguration)

Description copied from interface: ContextSubmittable

Submit a Context and a Service Configuration.

Specified by:

submitContextAndService in interface ContextSubmittable

Parameters:

contextConfiguration - the Configuration of the EvaluatorContext. See ContextConfiguration for details.

serviceConfiguration - the Configuration for the Services. See ServiceConfiguration for details.

submitContextAndTask

void submitContextAndTask(Configuration contextConfiguration,
                        Configuration taskConfiguration)

Description copied from interface: ContextAndTaskSubmittable

Submit a Context and a Task.

The semantics of this call are the same as first submitting the context and then, on the fired ActiveContext event to submit the Task. The performance of this will be better, though as it potentially saves some roundtrips on the network.

REEF will not fire an ActiveContext as a result of this. Instead, it will fire a TaskRunning event.

Specified by:

submitContextAndTask in interface ContextAndTaskSubmittable

Parameters:

contextConfiguration - the Configuration of the EvaluatorContext. See ContextConfiguration for details.

taskConfiguration - the Configuration of the Task. See TaskConfiguration for details.

submitContextAndServiceAndTask

void submitContextAndServiceAndTask(Configuration contextConfiguration,
                                  Configuration serviceConfiguration,
                                  Configuration taskConfiguration)

Description copied from interface: ContextAndTaskSubmittable

Subkit a Context with Services and a Task.

The semantics of this call are the same as first submitting the context and services and then, on the fired ActiveContext event to submit the Task. The performance of this will be better, though as it potentially saves some roundtrips on the network.

REEF will not fire an ActiveContext as a result of this. Instead, it will fire a TaskRunning event.

Specified by:

submitContextAndServiceAndTask in interface ContextAndTaskSubmittable