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 TaskManager registered at a JobManager and ready to receive work.

Constructor Summary

Constructors

Constructor and Description
Instance(akka.actor.ActorRef taskManager, InstanceConnectionInfo connectionInfo, InstanceID id, HardwareDescription resources, int numberOfSlots) Constructs an instance reflecting a registered TaskManager.

Method Summary

Modifier and Type	Method and Description
SharedSlot	allocateSharedSlot(JobID jobID, SlotSharingGroupAssignment sharingGroupAssignment, AbstractID groupID)
SimpleSlot	allocateSimpleSlot(JobID jobID)
SimpleSlot	allocateSimpleSlot(JobID jobID, AbstractID groupID)
void	cancelAndReleaseAllSlots()
InstanceID	getId()
InstanceConnectionInfo	getInstanceConnectionInfo()
long	getLastHeartBeat() Gets the timestamp of the last heartbeat.
byte[]	getLastMetricsReport()
int	getNumberOfAllocatedSlots()
int	getNumberOfAvailableSlots()
String	getPath()
HardwareDescription	getResources()
akka.actor.ActorRef	getTaskManager()
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(Slot slot)
void	setMetricsReport(byte[] lastMetricsReport)
void	setSlotAvailabilityListener(SlotAvailabilityListener slotAvailabilityListener)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Instance

public Instance(akka.actor.ActorRef taskManager,
                InstanceConnectionInfo connectionInfo,
                InstanceID id,
                HardwareDescription resources,
                int numberOfSlots)

Constructs an instance reflecting a registered TaskManager.

Parameters:

taskManager - The actor reference of the represented task manager.

connectionInfo - The remote connection where the task manager receives requests.

id - The id under which the taskManager is registered.

resources - The resources available on the machine.

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

Method Detail

getId

public InstanceID getId()

getResources

public HardwareDescription getResources()

getTotalNumberOfSlots

public int getTotalNumberOfSlots()

isAlive

public boolean isAlive()

markDead

public void markDead()

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.

setMetricsReport

public void setMetricsReport(byte[] lastMetricsReport)

getLastMetricsReport

public byte[] getLastMetricsReport()

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 taskManager is considered alive, false otherwise.

allocateSimpleSlot

public SimpleSlot allocateSimpleSlot(JobID jobID)
                              throws InstanceDiedException

Throws:

InstanceDiedException

allocateSimpleSlot

public SimpleSlot allocateSimpleSlot(JobID jobID,
                                     AbstractID groupID)
                              throws InstanceDiedException

Throws:

InstanceDiedException

allocateSharedSlot

public SharedSlot allocateSharedSlot(JobID jobID,
                                     SlotSharingGroupAssignment sharingGroupAssignment,
                                     AbstractID groupID)
                              throws InstanceDiedException

Throws:

InstanceDiedException

returnAllocatedSlot

public boolean returnAllocatedSlot(Slot slot)

cancelAndReleaseAllSlots

public void cancelAndReleaseAllSlots()

getTaskManager

public akka.actor.ActorRef getTaskManager()

getPath

public String getPath()

getInstanceConnectionInfo

public InstanceConnectionInfo getInstanceConnectionInfo()

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