org.apache.flink.runtime.protocols

Interface JobManagerProtocol

All Superinterfaces:

ServiceDiscoveryProtocol, VersionedProtocol

All Known Implementing Classes:

JobManager

public interface JobManagerProtocol
extends ServiceDiscoveryProtocol

The job manager protocol is implemented by the job manager and offers functionality to task managers which allows them to register themselves, send heart beat messages or to report the results of a task execution.

Method Summary

Methods

Modifier and Type	Method and Description
InstanceID	registerTaskManager(InstanceConnectionInfo instanceConnectionInfo, HardwareDescription hardwareDescription, int numberOfSlots) Registers a task manager at the JobManager.
boolean	sendHeartbeat(InstanceID taskManagerId) Sends a heart beat to the job manager.
boolean	updateTaskExecutionState(TaskExecutionState taskExecutionState) Reports an update of a task's execution state to the job manager.

Methods inherited from interface org.apache.flink.runtime.protocols.ServiceDiscoveryProtocol

getBlobServerPort

Method Detail

sendHeartbeat

boolean sendHeartbeat(InstanceID taskManagerId)
                      throws IOException

Sends a heart beat to the job manager.

Parameters:

taskManagerId - The ID identifying the task manager.

Throws:

IOException - Thrown if an error occurs during this remote procedure call.

registerTaskManager

InstanceID registerTaskManager(InstanceConnectionInfo instanceConnectionInfo,
                             HardwareDescription hardwareDescription,
                             int numberOfSlots)
                               throws IOException

Registers a task manager at the JobManager.

Parameters:

instanceConnectionInfo - the information the job manager requires to connect to the instance's task manager

hardwareDescription - a hardware description with details on the instance's compute resources.

numberOfSlots - The number of task slots that the TaskManager provides.

Returns:

The ID under which the TaskManager is registered. Null, if the JobManager does not register the TaskManager.

Throws:

IOException

updateTaskExecutionState

boolean updateTaskExecutionState(TaskExecutionState taskExecutionState)
                                 throws IOException

Reports an update of a task's execution state to the job manager. This method returns true, if the state was correctly registered. It it returns false, the calling task manager should cancel its execution of the task.

Parameters:

taskExecutionState - The new task execution state.

Returns:

True if everything is all right, false if the caller should cancel the task execution.

Throws:

IOException - Thrown, if an error occurs during this remote procedure call