org.apache.flink.runtime.resourcemanager

Interface ResourceManagerGateway

All Superinterfaces:

RpcGateway

public interface ResourceManagerGateway
extends RpcGateway

The ResourceManager's RPC gateway interface.

Method Summary

Methods

Modifier and Type	Method and Description
void	disconnectJobManager(JobID jobId, Exception cause) Disconnects a JobManager specified by the given resourceID from the ResourceManager.
void	disconnectTaskManager(ResourceID resourceID, Exception cause) Disconnects a TaskManager specified by the given resourceID from the ResourceManager.
Future<Integer>	getNumberOfRegisteredTaskManagers(UUID leaderSessionId) Gets the currently registered number of TaskManagers.
void	heartbeatFromJobManager(ResourceID heartbeatOrigin) Sends the heartbeat to resource manager from job manager
void	heartbeatFromTaskManager(ResourceID heartbeatOrigin) Sends the heartbeat to resource manager from task manager
void	notifySlotAvailable(UUID resourceManagerLeaderId, InstanceID instanceId, SlotID slotID, AllocationID oldAllocationId) Sent by the TaskExecutor to notify the ResourceManager that a slot has become available.
void	registerInfoMessageListener(String infoMessageListenerAddress) Registers an infoMessage listener
Future<RegistrationResponse>	registerJobManager(UUID resourceManagerLeaderId, UUID jobMasterLeaderId, ResourceID jobMasterResourceId, String jobMasterAddress, JobID jobID, Time timeout) Register a JobMaster at the resource manager.
Future<RegistrationResponse>	registerTaskExecutor(UUID resourceManagerLeaderId, String taskExecutorAddress, ResourceID resourceID, SlotReport slotReport, Time timeout) Register a TaskExecutor at the resource manager.
Future<Acknowledge>	requestSlot(UUID resourceManagerLeaderID, UUID jobMasterLeaderID, SlotRequest slotRequest, Time timeout) Requests a slot from the resource manager.
void	shutDownCluster(ApplicationStatus finalStatus, String optionalDiagnostics) shutdown cluster
void	unRegisterInfoMessageListener(String infoMessageListenerAddress) Unregisters an infoMessage listener

Methods inherited from interface org.apache.flink.runtime.rpc.RpcGateway

getAddress, getHostname

Method Detail

registerJobManager

Future<RegistrationResponse> registerJobManager(UUID resourceManagerLeaderId,
                                              UUID jobMasterLeaderId,
                                              ResourceID jobMasterResourceId,
                                              String jobMasterAddress,
                                              JobID jobID,
                                              Time timeout)

Register a JobMaster at the resource manager.

Parameters:

resourceManagerLeaderId - The fencing token for the ResourceManager leader

jobMasterLeaderId - The fencing token for the JobMaster leader

jobMasterResourceId - The resource ID of the JobMaster that registers

jobMasterAddress - The address of the JobMaster that registers

jobID - The Job ID of the JobMaster that registers

timeout - Timeout for the future to complete

Returns:

Future registration response

requestSlot

Future<Acknowledge> requestSlot(UUID resourceManagerLeaderID,
                              UUID jobMasterLeaderID,
                              SlotRequest slotRequest,
                              Time timeout)

Requests a slot from the resource manager.

Parameters:

resourceManagerLeaderID - leader if of the ResourceMaster

jobMasterLeaderID - leader if of the JobMaster

slotRequest - The slot to request

Returns:

The confirmation that the slot gets allocated

registerTaskExecutor

Future<RegistrationResponse> registerTaskExecutor(UUID resourceManagerLeaderId,
                                                String taskExecutorAddress,
                                                ResourceID resourceID,
                                                SlotReport slotReport,
                                                Time timeout)

Register a TaskExecutor at the resource manager.

Parameters:

resourceManagerLeaderId - The fencing token for the ResourceManager leader

taskExecutorAddress - The address of the TaskExecutor that registers

resourceID - The resource ID of the TaskExecutor that registers

slotReport - The slot report containing free and allocated task slots

timeout - The timeout for the response.

Returns:

The future to the response by the ResourceManager.

notifySlotAvailable

void notifySlotAvailable(UUID resourceManagerLeaderId,
                       InstanceID instanceId,
                       SlotID slotID,
                       AllocationID oldAllocationId)

Sent by the TaskExecutor to notify the ResourceManager that a slot has become available.

Parameters:

resourceManagerLeaderId - The ResourceManager leader id

instanceId - TaskExecutor's instance id

slotID - The SlotID of the freed slot

oldAllocationId - to which the slot has been allocated

registerInfoMessageListener

void registerInfoMessageListener(String infoMessageListenerAddress)

Registers an infoMessage listener

Parameters:

infoMessageListenerAddress - address of infoMessage listener to register to this resource manager

unRegisterInfoMessageListener

void unRegisterInfoMessageListener(String infoMessageListenerAddress)

Unregisters an infoMessage listener

Parameters:

infoMessageListenerAddress - address of infoMessage listener to unregister from this resource manager

shutDownCluster

void shutDownCluster(ApplicationStatus finalStatus,
                   String optionalDiagnostics)

shutdown cluster

Parameters:

finalStatus -

optionalDiagnostics -

getNumberOfRegisteredTaskManagers

Future<Integer> getNumberOfRegisteredTaskManagers(UUID leaderSessionId)

Gets the currently registered number of TaskManagers.

Parameters:

leaderSessionId - The leader session ID with which to address the ResourceManager.

Returns:

The future to the number of registered TaskManagers.

heartbeatFromTaskManager

void heartbeatFromTaskManager(ResourceID heartbeatOrigin)

Sends the heartbeat to resource manager from task manager

Parameters:

heartbeatOrigin - unique id of the task manager

heartbeatFromJobManager

void heartbeatFromJobManager(ResourceID heartbeatOrigin)

Sends the heartbeat to resource manager from job manager

Parameters:

heartbeatOrigin - unique id of the job manager

disconnectTaskManager

void disconnectTaskManager(ResourceID resourceID,
                         Exception cause)

Disconnects a TaskManager specified by the given resourceID from the ResourceManager.

Parameters:

resourceID - identifying the TaskManager to disconnect

cause - for the disconnection of the TaskManager

disconnectJobManager

void disconnectJobManager(JobID jobId,
                        Exception cause)

Disconnects a JobManager specified by the given resourceID from the ResourceManager.

Parameters:

jobId - JobID for which the JobManager was the leader

cause - for the disconnection of the JobManager