org.apache.flink.runtime.protocols

Interface TaskOperationProtocol

All Superinterfaces:

VersionedProtocol

All Known Implementing Classes:

TaskManager

public interface TaskOperationProtocol
extends VersionedProtocol

The task submission protocol is implemented by the task manager and allows the job manager to submit and cancel tasks, as well as to query the task manager for cached libraries and submit these if necessary.

Method Summary

Methods

Modifier and Type	Method and Description
TaskCancelResult	cancelTask(ExecutionVertexID id) Advises the task manager to cancel the task with the given ID.
LibraryCacheProfileResponse	getLibraryCacheProfile(LibraryCacheProfileRequest request) Queries the task manager about the cache status of the libraries stated in the LibraryCacheProfileRequest object.
void	invalidateLookupCacheEntries(Set<ChannelID> channelIDs) Invalidates the entries identified by the given channel IDs from the task manager's receiver lookup cache.
TaskKillResult	killTask(ExecutionVertexID id) Advises the task manager to kill the task with the given ID.
void	killTaskManager() Kills the task manager.
void	logBufferUtilization() Triggers the task manager write the current utilization of its read and write buffers to its logs.
List<TaskSubmissionResult>	submitTasks(List<TaskDeploymentDescriptor> tasks) Submits a list of tasks to the task manager.
void	updateLibraryCache(LibraryCacheUpdate update) Updates the task manager's library cache.

Method Detail

submitTasks

List<TaskSubmissionResult> submitTasks(List<TaskDeploymentDescriptor> tasks)
                                       throws IOException

Submits a list of tasks to the task manager.

Parameters:

tasks - the tasks to be submitted

Returns:

the result of the task submission

Throws:

IOException - thrown if an error occurs during this remote procedure call

cancelTask

TaskCancelResult cancelTask(ExecutionVertexID id)
                            throws IOException

Advises the task manager to cancel the task with the given ID.

Parameters:

id - the ID of the task to cancel

Returns:

the result of the task cancel attempt

Throws:

IOException - thrown if an error occurs during this remote procedure call

killTask

TaskKillResult killTask(ExecutionVertexID id)
                        throws IOException

Advises the task manager to kill the task with the given ID.

Parameters:

id - the ID of the task to kill

Returns:

the result of the task kill attempt

Throws:

IOException - thrown if an error occurs during this remote procedure call

getLibraryCacheProfile

LibraryCacheProfileResponse getLibraryCacheProfile(LibraryCacheProfileRequest request)
                                                   throws IOException

Queries the task manager about the cache status of the libraries stated in the LibraryCacheProfileRequest object.

Parameters:

request - a LibraryCacheProfileRequest containing a list of libraries whose cache status is to be determined

Returns:

a LibraryCacheProfileResponse containing the cache status for each library included in the request

Throws:

IOException - thrown if an error occurs during this remote procedure call

updateLibraryCache

void updateLibraryCache(LibraryCacheUpdate update)
                        throws IOException

Updates the task manager's library cache.

Parameters:

update - a LibraryCacheUpdate object used to transmit the library data

Throws:

IOException - thrown if an error occurs during this remote procedure call

invalidateLookupCacheEntries

void invalidateLookupCacheEntries(Set<ChannelID> channelIDs)
                                  throws IOException

Invalidates the entries identified by the given channel IDs from the task manager's receiver lookup cache.

Parameters:

channelIDs - the channel IDs identifying the cache entries to invalidate

Throws:

IOException - thrown if an error occurs during this remote procedure call

logBufferUtilization

void logBufferUtilization()

Triggers the task manager write the current utilization of its read and write buffers to its logs. This method is primarily for debugging purposes.

Throws:

IOException - thrown if an error occurs while transmitting the request

killTaskManager

void killTaskManager()
                     throws IOException

Kills the task manager. This method is mainly intended to test and debug Nephele's fault tolerance mechanisms.

Throws:

IOException - thrown if an error occurs during this remote procedure call