org.apache.flink.runtime.instance

Class SimpleSlot

java.lang.Object

org.apache.flink.runtime.instance.Slot

org.apache.flink.runtime.instance.SimpleSlot

public class SimpleSlot
extends Slot

A SimpleSlot represents a single slot on a TaskManager instance, or a slot within a shared slot.

If this slot is part of a SharedSlot, then the parent attribute will point to that shared slot. If not, then the parent attribute is null.

Constructor Summary

Constructors

Constructor and Description
SimpleSlot(org.apache.flink.api.common.JobID jobID, Instance instance, int slotNumber) Creates a new simple slot that stands alone and does not belong to shared slot.
SimpleSlot(org.apache.flink.api.common.JobID jobID, Instance instance, int slotNumber, SharedSlot parent, org.apache.flink.util.AbstractID groupID) Creates a new simple slot that belongs to the given shared slot and is identified by the given ID..

Method Summary

Modifier and Type	Method and Description
Execution	getExecutedVertex() Gets the task execution attempt currently executed in this slot.
Locality	getLocality() Gets the locality information attached to this slot.
int	getNumberLeaves() Gets the number of simple slots that are at the leaves of the tree of slots.
void	releaseSlot() This method cancels and releases the slot and all its sub-slots.
boolean	setExecutedVertex(Execution executedVertex) Atomically sets the executed vertex, if no vertex has been assigned to this slot so far.
void	setLocality(Locality locality) Attached locality information to this slot.
String	toString()

Methods inherited from class org.apache.flink.runtime.instance.Slot

getGroupID, getInstance, getJobID, getParent, getRoot, getRootSlotNumber, getSlotNumber, hierarchy, isAlive, isCanceled, isReleased

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleSlot

public SimpleSlot(org.apache.flink.api.common.JobID jobID,
                  Instance instance,
                  int slotNumber)

Creates a new simple slot that stands alone and does not belong to shared slot.

Parameters:

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

instance - The instance that the slot belongs to.

slotNumber - The number of the task slot on the instance.

SimpleSlot

public SimpleSlot(org.apache.flink.api.common.JobID jobID,
                  Instance instance,
                  int slotNumber,
                  SharedSlot parent,
                  org.apache.flink.util.AbstractID groupID)

Creates a new simple slot that belongs to the given shared slot and is identified by the given ID..

Parameters:

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

instance - The instance that the slot belongs to.

slotNumber - The number of the simple slot in its parent shared slot.

parent - The parent shared slot.

groupID - The ID that identifies the group that the slot belongs to.

Method Detail

getNumberLeaves

public int getNumberLeaves()

Description copied from class: Slot

Gets the number of simple slots that are at the leaves of the tree of slots.

Specified by:

getNumberLeaves in class Slot

Returns:

The number of simple slots at the leaves.

getExecutedVertex

public Execution getExecutedVertex()

Gets the task execution attempt currently executed in this slot. This may return null, if no task execution attempt has been placed into this slot.

Returns:

The slot's task execution attempt, or null, if no task is executed in this slot, yet.

setExecutedVertex

public boolean setExecutedVertex(Execution executedVertex)

Atomically sets the executed vertex, if no vertex has been assigned to this slot so far.

Parameters:

executedVertex - The vertex to assign to this slot.

Returns:

True, if the vertex was assigned, false, otherwise.

getLocality

public Locality getLocality()

Gets the locality information attached to this slot.

Returns:

The locality attached to the slot.

setLocality

public void setLocality(Locality locality)

Attached locality information to this slot.

Parameters:

locality - The locality attached to the slot.

releaseSlot

public void releaseSlot()

Description copied from class: Slot

This method cancels and releases the slot and all its sub-slots. After this method completed successfully, the slot will be in state "released", and the Slot.isReleased() method will return true. If this slot is a simple slot, it will be returned to its instance. If it is a shared slot, it will release all of its sub-slots and release itself.

Specified by:

releaseSlot in class Slot

toString

public String toString()

Overrides:

toString in class Slot