org.apache.flink.runtime.taskmanager

Class Task

java.lang.Object

org.apache.flink.runtime.taskmanager.Task

All Implemented Interfaces:

ExecutionObserver

public final class Task
extends Object
implements ExecutionObserver

Constructor Summary

Constructors

Constructor and Description
Task(ExecutionVertexID vertexID, RuntimeEnvironment environment, TaskManager taskManager)

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelExecution()
void	executionStateChanged(ExecutionState newExecutionState, String optionalMessage) Called when the execution state of the associated task has changed.
Environment	getEnvironment() Returns the environment associated with this task.
ExecutionState	getExecutionState() Returns the current execution state of the task.
JobID	getJobID() Returns the ID of the job this task belongs to.
RuntimeEnvironment	getRuntimeEnvironment() Returns the runtime environment associated with this task.
ExecutionVertexID	getVertexID() Returns the ID of this task.
boolean	isCanceled() Returns whether the task has been canceled.
boolean	isTerminated() Checks if the state of the thread which is associated with this task is TERMINATED.
void	killExecution()
void	markAsFailed() Marks the task as failed and triggers the appropriate state changes.
void	registerExecutionListener(ExecutionListener executionListener) Registers the ExecutionListener object for this task.
void	registerProfiler(TaskManagerProfiler taskManagerProfiler, Configuration jobConfiguration) Registers the task manager profiler with the task.
void	startExecution() Starts the execution of this task.
void	unregisterExecutionListener(ExecutionListener executionListener) Unregisters the ExecutionListener object for this environment.
void	unregisterMemoryManager(MemoryManager memoryManager) Unregisters the task from the central memory manager.
void	unregisterProfiler(TaskManagerProfiler taskManagerProfiler) Unregisters the task from the task manager profiler.
void	userThreadFinished(Thread userThread) Called when a thread spawn by a user task has finished.
void	userThreadStarted(Thread userThread) Called when the user task has started a new thread.

Methods inherited from class java.lang.Object

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

Constructor Detail

Task

public Task(ExecutionVertexID vertexID,
    RuntimeEnvironment environment,
    TaskManager taskManager)

Method Detail

getJobID

public JobID getJobID()

Returns the ID of the job this task belongs to.

Returns:

the ID of the job this task belongs to

getVertexID

public ExecutionVertexID getVertexID()

Returns the ID of this task.

Returns:

the ID of this task

getEnvironment

public Environment getEnvironment()

Returns the environment associated with this task.

Returns:

the environment associated with this task

markAsFailed

public void markAsFailed()

Marks the task as failed and triggers the appropriate state changes.

cancelExecution

public void cancelExecution()

killExecution

public void killExecution()

isTerminated

public boolean isTerminated()

Checks if the state of the thread which is associated with this task is TERMINATED.

Returns:

true if the state of this thread which is associated with this task is TERMINATED, false otherwise

startExecution

public void startExecution()

Starts the execution of this task.

registerProfiler

public void registerProfiler(TaskManagerProfiler taskManagerProfiler,
                    Configuration jobConfiguration)

Registers the task manager profiler with the task.

Parameters:

taskManagerProfiler - the task manager profiler

jobConfiguration - the configuration attached to the job

unregisterMemoryManager

public void unregisterMemoryManager(MemoryManager memoryManager)

Unregisters the task from the central memory manager.

Parameters:

memoryManager - the central memory manager

unregisterProfiler

public void unregisterProfiler(TaskManagerProfiler taskManagerProfiler)

Unregisters the task from the task manager profiler.

Parameters:

taskManagerProfiler - the task manager profiler

getExecutionState

public ExecutionState getExecutionState()

Returns the current execution state of the task.

Returns:

the current execution state of the task

executionStateChanged

public void executionStateChanged(ExecutionState newExecutionState,
                         String optionalMessage)

Description copied from interface: ExecutionObserver

Called when the execution state of the associated task has changed.

Specified by:

executionStateChanged in interface ExecutionObserver

Parameters:

newExecutionState - the execution state the task has just switched to

optionalMessage - an optional message providing further information on the state change

userThreadStarted

public void userThreadStarted(Thread userThread)

Description copied from interface: ExecutionObserver

Called when the user task has started a new thread.

Specified by:

userThreadStarted in interface ExecutionObserver

Parameters:

userThread - the user thread which has been started

userThreadFinished

public void userThreadFinished(Thread userThread)

Description copied from interface: ExecutionObserver

Called when a thread spawn by a user task has finished.

Specified by:

userThreadFinished in interface ExecutionObserver

Parameters:

userThread - the user thread which has finished

registerExecutionListener

public void registerExecutionListener(ExecutionListener executionListener)

Registers the ExecutionListener object for this task. This object will be notified about important events during the task execution.

Parameters:

executionListener - the object to be notified for important events during the task execution

unregisterExecutionListener

public void unregisterExecutionListener(ExecutionListener executionListener)

Unregisters the ExecutionListener object for this environment. This object will no longer be notified about important events during the task execution.

Parameters:

executionListener - the lister object to be unregistered

isCanceled

public boolean isCanceled()

Description copied from interface: ExecutionObserver

Returns whether the task has been canceled.

Specified by:

isCanceled in interface ExecutionObserver

Returns:

true if the task has been canceled, false otherwise

getRuntimeEnvironment

public RuntimeEnvironment getRuntimeEnvironment()

Returns the runtime environment associated with this task.

Returns:

the runtime environment associated with this task