org.apache.flink.runtime.instance

Class Instance

java.lang.Object

org.apache.flink.runtime.topology.NetworkNode

org.apache.flink.runtime.instance.Instance

All Implemented Interfaces:

IOReadableWritable

Direct Known Subclasses:

DummyInstance

public class Instance
extends NetworkNode

An instance represents a resource a TaskManager runs on.

Constructor Summary

Constructors

Constructor and Description
Instance(InstanceConnectionInfo instanceConnectionInfo, NetworkNode parentNode, NetworkTopology networkTopology, HardwareDescription hardwareDescription, int numberOfSlots) Constructs an abstract instance object.

Method Summary

Methods

Modifier and Type	Method and Description
AllocatedResource	allocateSlot(JobID jobID)
TaskCancelResult	cancelTask(ExecutionVertexID id) Cancels the task identified by the given ID at the instance's TaskManager.
void	checkLibraryAvailability(JobID jobID) Checks if all the libraries required to run the job with the given job ID are available on this instance.
void	destroyProxies() Destroys all RPC stub objects attached to this instance.
boolean	equals(Object obj)
Collection<AllocatedSlot>	getAllocatedSlots()
HardwareDescription	getHardwareDescription() Returns the instance's hardware description as reported by the instance itself.
InstanceConnectionInfo	getInstanceConnectionInfo() Returns the instance's connection information object.
long	getLastHeartBeat()
int	getNumberOfAvailableSlots()
int	getNumberOfSlots()
int	hashCode()
void	invalidateLookupCacheEntries(Set<ChannelID> channelIDs) Invalidates the entries identified by the given channel IDs from the remote task manager's receiver lookup cache.
boolean	isStillAlive(long cleanUpInterval) Returns whether the host is still alive.
TaskKillResult	killTask(ExecutionVertexID id) Kills the task identified by the given ID at the instance's TaskManager.
void	killTaskManager() Kills the task manager running on this instance.
void	logBufferUtilization() Triggers the remote task manager to print out the current utilization of its read and write buffers to its logs.
void	releaseSlot(AllocationID allocationID)
Collection<AllocatedSlot>	removeAllocatedSlots()
void	reportHeartBeat() Updates the time of last received heart beat to the current system time.
List<TaskSubmissionResult>	submitTasks(List<TaskDeploymentDescriptor> tasks) Submits a list of tasks to the instance's TaskManager.

Methods inherited from class org.apache.flink.runtime.topology.NetworkNode

getChildNode, getDepth, getDistance, getDistance, getHeight, getName, getNetworkTopology, getNumberOfChildNodes, getParentNode, isLeafNode, isRootNode, read, remove, toString, write

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Instance

public Instance(InstanceConnectionInfo instanceConnectionInfo,
        NetworkNode parentNode,
        NetworkTopology networkTopology,
        HardwareDescription hardwareDescription,
        int numberOfSlots)

Constructs an abstract instance object.

Parameters:

instanceConnectionInfo - the connection info identifying the instance

parentNode - the parent node in the network topology

networkTopology - the network topology this node is a part of

hardwareDescription - the hardware description provided by the instance itself

Method Detail

getInstanceConnectionInfo

public final InstanceConnectionInfo getInstanceConnectionInfo()

Returns the instance's connection information object.

Returns:

the instance's connection information object

getHardwareDescription

public HardwareDescription getHardwareDescription()

Returns the instance's hardware description as reported by the instance itself.

Returns:

the instance's hardware description

checkLibraryAvailability

public void checkLibraryAvailability(JobID jobID)
                              throws IOException

Checks if all the libraries required to run the job with the given job ID are available on this instance. Any libary that is missing is transferred to the instance as a result of this call.

Parameters:

jobID - the ID of the job whose libraries are to be checked for

Throws:

IOException - thrown if an error occurs while checking for the libraries

submitTasks

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

Submits a list of tasks to the instance's TaskManager.

Parameters:

tasks - the list of tasks to be submitted

Returns:

the result of the submission attempt

Throws:

IOException - thrown if an error occurs while transmitting the task

cancelTask

public TaskCancelResult cancelTask(ExecutionVertexID id)
                            throws IOException

Cancels the task identified by the given ID at the instance's TaskManager.

Parameters:

id - the ID identifying the task to be canceled

Returns:

the result of the cancel attempt

Throws:

IOException - thrown if an error occurs while transmitting the request or receiving the response

killTask

public TaskKillResult killTask(ExecutionVertexID id)
                        throws IOException

Kills the task identified by the given ID at the instance's TaskManager.

Parameters:

id - the ID identifying the task to be killed

Returns:

the result of the kill attempt

Throws:

IOException - thrown if an error occurs while transmitting the request or receiving the response

reportHeartBeat

public void reportHeartBeat()

Updates the time of last received heart beat to the current system time.

isStillAlive

public boolean isStillAlive(long cleanUpInterval)

Returns whether the host is still alive.

Parameters:

cleanUpInterval - duration (in milliseconds) after which a host is considered dead if it has no received heat-beats.

Returns:

true if the host has received a heat-beat before the cleanUpInterval duration has expired, false otherwise

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

logBufferUtilization

public void logBufferUtilization()
                          throws IOException

Triggers the remote task manager to print out the current utilization of its read and write buffers to its logs.

Throws:

IOException - thrown if an error occurs while transmitting the request

killTaskManager

public void killTaskManager()
                     throws IOException

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

Throws:

IOException - thrown if an error occurs while transmitting the request

invalidateLookupCacheEntries

public void invalidateLookupCacheEntries(Set<ChannelID> channelIDs)
                                  throws IOException

Invalidates the entries identified by the given channel IDs from the remote 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

destroyProxies

public void destroyProxies()

Destroys all RPC stub objects attached to this instance.

getNumberOfSlots

public int getNumberOfSlots()

getNumberOfAvailableSlots

public int getNumberOfAvailableSlots()

allocateSlot

public AllocatedResource allocateSlot(JobID jobID)
                               throws InstanceException

Throws:

InstanceException

releaseSlot

public void releaseSlot(AllocationID allocationID)

getAllocatedSlots

public Collection<AllocatedSlot> getAllocatedSlots()

removeAllocatedSlots

public Collection<AllocatedSlot> removeAllocatedSlots()

getLastHeartBeat

public long getLastHeartBeat()