org.apache.flink.runtime.instance

Class Instance

java.lang.Object

org.apache.flink.runtime.instance.Instance

public class Instance
extends Object

An instance represents a resource a TaskManager runs on.

Constructor Summary

Constructors

Constructor and Description
Instance(InstanceConnectionInfo instanceConnectionInfo, InstanceID id, HardwareDescription resources, int numberOfSlots) Constructs an abstract instance object.

Method Summary

Modifier and Type	Method and Description
AllocatedSlot	allocateSlot(JobID jobID)
void	cancelAndReleaseAllSlots()
InstanceID	getId()
InstanceConnectionInfo	getInstanceConnectionInfo() Returns the instance's connection information object.
long	getLastHeartBeat() Gets the timestamp of the last heartbeat.
int	getNumberOfAllocatedSlots()
int	getNumberOfAvailableSlots()
HardwareDescription	getResources()
TaskOperationProtocol	getTaskManagerProxy()
int	getTotalNumberOfSlots()
boolean	hasResourcesAvailable()
boolean	isAlive()
boolean	isStillAlive(long now, long cleanUpInterval) Checks whether the last heartbeat occurred within the last n milliseconds before the given timestamp now.
void	markDead()
void	removeSlotListener()
void	reportHeartBeat() Updates the time of last received heart beat to the current system time.
boolean	returnAllocatedSlot(AllocatedSlot slot)
void	setSlotAvailabilityListener(SlotAvailabilityListener slotAvailabilityListener)
void	stopInstance()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Instance

public Instance(InstanceConnectionInfo instanceConnectionInfo,
                InstanceID id,
                HardwareDescription resources,
                int numberOfSlots)

Constructs an abstract instance object.

Parameters:

instanceConnectionInfo - The connection info under which to reach the TaskManager instance.

id - The id under which the instance is registered.

resources - The resources available on the machine.

numberOfSlots - The number of task slots offered by this instance.

Method Detail

getId

public InstanceID getId()

getResources

public HardwareDescription getResources()

getTotalNumberOfSlots

public int getTotalNumberOfSlots()

getInstanceConnectionInfo

public InstanceConnectionInfo getInstanceConnectionInfo()

Returns the instance's connection information object.

Returns:

the instance's connection information object

isAlive

public boolean isAlive()

stopInstance

public void stopInstance()

markDead

public void markDead()

getTaskManagerProxy

public TaskOperationProtocol getTaskManagerProxy()
                                          throws IOException

Throws:

IOException

getLastHeartBeat

public long getLastHeartBeat()

Gets the timestamp of the last heartbeat.

Returns:

The timestamp of the last heartbeat.

reportHeartBeat

public void reportHeartBeat()

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

isStillAlive

public boolean isStillAlive(long now,
                            long cleanUpInterval)

Checks whether the last heartbeat occurred within the last n milliseconds before the given timestamp now.

Parameters:

now - The timestamp representing the current time.

cleanUpInterval - The maximum time (in msecs) that the last heartbeat may lie in the past.

Returns:

True, if this instance is considered alive, false otherwise.

allocateSlot

public AllocatedSlot allocateSlot(JobID jobID)
                           throws InstanceDiedException

Throws:

InstanceDiedException

returnAllocatedSlot

public boolean returnAllocatedSlot(AllocatedSlot slot)

cancelAndReleaseAllSlots

public void cancelAndReleaseAllSlots()

getNumberOfAvailableSlots

public int getNumberOfAvailableSlots()

getNumberOfAllocatedSlots

public int getNumberOfAllocatedSlots()

hasResourcesAvailable

public boolean hasResourcesAvailable()

setSlotAvailabilityListener

public void setSlotAvailabilityListener(SlotAvailabilityListener slotAvailabilityListener)

removeSlotListener

public void removeSlotListener()

toString

public String toString()

Overrides:

toString in class Object