org.apache.reef.client

Class DriverLauncher

java.lang.Object

org.apache.reef.client.DriverLauncher

public final class DriverLauncher
extends Object

A launcher for REEF Drivers.

It can be instantiated using a configuration that can create a REEF instance. For example, the local resourcemanager and the YARN resourcemanager can do this.

See org.apache.reef.examples.hello package for a demo use case.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DriverLauncher.CompletedJobHandler Job driver notifies us that the job had completed successfully.
class	DriverLauncher.FailedJobHandler Job driver notifies us that the job had failed.
class	DriverLauncher.RunningJobHandler Job driver notifies us that the job is running.
class	DriverLauncher.RuntimeErrorHandler Handler an error in the job driver.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Kills the running job.
static DriverLauncher	getLauncher(Configuration runtimeConfiguration) Instantiate a launcher for the given Configuration.
LauncherStatus	getStatus()
LauncherStatus	run(Configuration driverConfig) Run a job.
LauncherStatus	run(Configuration driverConfig, long timeOut) Run a job with a waiting timeout after which it will be killed, if it did not complete yet.
void	setStatusAndNotify(LauncherStatus status) Update job status and notify the waiting thread.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getLauncher

public static DriverLauncher getLauncher(Configuration runtimeConfiguration)
                                  throws BindException,
                                         InjectionException

Instantiate a launcher for the given Configuration.

Parameters:

runtimeConfiguration - the resourcemanager configuration to be used

Returns:

a DriverLauncher based on the given resourcemanager configuration

Throws:

BindException - on configuration errors

InjectionException - on configuration errors

close

public void close()

Kills the running job.

run

public LauncherStatus run(Configuration driverConfig)

Run a job. Waits indefinitely for the job to complete.

Parameters:

driverConfig - the configuration for the driver. See DriverConfiguration for details.

Returns:

the state of the job after execution.

run

public LauncherStatus run(Configuration driverConfig,
                 long timeOut)

Run a job with a waiting timeout after which it will be killed, if it did not complete yet.

Parameters:

driverConfig - the configuration for the driver. See DriverConfiguration for details.

timeOut - timeout on the job.

Returns:

the state of the job after execution.

getStatus

public LauncherStatus getStatus()

Returns:

the current status of the job.

setStatusAndNotify

public void setStatusAndNotify(LauncherStatus status)

Update job status and notify the waiting thread.

toString

public String toString()

Overrides:

toString in class Object