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(ActorGateway actorGateway, 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) Allocates a shared slot on this TaskManager instance.
SimpleSlot	allocateSimpleSlot(JobID jobID) Allocates a simple slot on this TaskManager instance.
void	cancelAndReleaseAllSlots()
ActorGateway	getActorGateway() Returns the InstanceGateway of this Instance.
InstanceID	getId()
InstanceConnectionInfo	getInstanceConnectionInfo()
long	getLastHeartBeat() Gets the timestamp of the last heartbeat.
byte[]	getLastMetricsReport()
int	getNumberOfAllocatedSlots()
int	getNumberOfAvailableSlots()
HardwareDescription	getResources()
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() Removes the listener that receives notifications for slot availability.
void	reportHeartBeat() Updates the time of last received heart beat to the current system time.
boolean	returnAllocatedSlot(Slot slot) Returns a slot that has been allocated from this instance.
void	setMetricsReport(byte[] lastMetricsReport)
void	setSlotAvailabilityListener(SlotAvailabilityListener slotAvailabilityListener) Sets the listener that receives notifications for slot availability.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Instance

public Instance(ActorGateway actorGateway,
                InstanceConnectionInfo connectionInfo,
                InstanceID id,
                HardwareDescription resources,
                int numberOfSlots)

Constructs an instance reflecting a registered TaskManager.

Parameters:

actorGateway - The actor gateway to communicate with the remote instance

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

Allocates a simple slot on this TaskManager instance. This method returns null, if no slot is available at the moment.

Parameters:

jobID - The ID of the job that the slot is allocated for.

Returns:

A simple slot that represents a task slot on this TaskManager instance, or null, if the TaskManager instance has no more slots available.

Throws:

InstanceDiedException - Thrown if the instance is no longer alive by the time the slot is allocated.

allocateSharedSlot

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

Allocates a shared slot on this TaskManager instance. This method returns null, if no slot is available at the moment. The shared slot will be managed by the given SlotSharingGroupAssignment.

Parameters:

jobID - The ID of the job that the slot is allocated for.

sharingGroupAssignment - The assignment group that manages this shared slot.

Returns:

A shared slot that represents a task slot on this TaskManager instance and can hold other (shared) slots, or null, if the TaskManager instance has no more slots available.

Throws:

InstanceDiedException - Thrown if the instance is no longer alive by the time the slot is allocated.

returnAllocatedSlot

public boolean returnAllocatedSlot(Slot slot)

Returns a slot that has been allocated from this instance. The slot needs have been canceled prior to calling this method.

The method will transition the slot to the "released" state. If the slot is already in state "released", this method will do nothing.

Parameters:

slot - The slot to return.

Returns:

True, if the slot was returned, false if not.

cancelAndReleaseAllSlots

public void cancelAndReleaseAllSlots()

getActorGateway

public ActorGateway getActorGateway()

Returns the InstanceGateway of this Instance. This gateway can be used to communicate with it.

Returns:

InstanceGateway associated with this instance

getInstanceConnectionInfo

public InstanceConnectionInfo getInstanceConnectionInfo()

getNumberOfAvailableSlots

public int getNumberOfAvailableSlots()

getNumberOfAllocatedSlots

public int getNumberOfAllocatedSlots()

hasResourcesAvailable

public boolean hasResourcesAvailable()

setSlotAvailabilityListener

public void setSlotAvailabilityListener(SlotAvailabilityListener slotAvailabilityListener)

Sets the listener that receives notifications for slot availability.

Parameters:

slotAvailabilityListener - The listener.

removeSlotListener

public void removeSlotListener()

Removes the listener that receives notifications for slot availability.

toString

public String toString()

Overrides:

toString in class Object