org.apache.flink.runtime.instance

Class SimpleSlot

java.lang.Object

org.apache.flink.runtime.instance.Slot

org.apache.flink.runtime.instance.SimpleSlot

All Implemented Interfaces:

LogicalSlot

public class SimpleSlot
extends Slot
implements LogicalSlot

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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.runtime.jobmaster.LogicalSlot

LogicalSlot.Payload

Field Summary

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

NO_ALLOCATION_ID, NO_SLOT_REQUEST_ID, NO_SLOT_SHARING_GROUP_ID

Fields inherited from interface org.apache.flink.runtime.jobmaster.LogicalSlot

TERMINATED_PAYLOAD

Constructor Summary

Constructors

Constructor and Description
SimpleSlot(SharedSlot parent, SlotOwner owner, int slotNumber, 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..
SimpleSlot(SlotContext slotContext, SlotOwner owner, int slotNumber) Creates a new simple slot that stands alone and does not belong to shared slot.
SimpleSlot(SlotOwner owner, TaskManagerLocation location, int slotNumber, TaskManagerGateway taskManagerGateway) Creates a new simple slot that stands alone and does not belong to shared slot.
SimpleSlot(SlotOwner owner, TaskManagerLocation location, int slotNumber, TaskManagerGateway taskManagerGateway, 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
AllocationID	getAllocationId() Gets the allocation id of 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.
LogicalSlot.Payload	getPayload() Returns the set payload or null if none.
int	getPhysicalSlotNumber() Gets the slot number on the TaskManager.
SlotRequestId	getSlotRequestId() Gets the slot request id uniquely identifying the request with which this slot has been allocated.
SlotSharingGroupId	getSlotSharingGroupId() Gets the slot sharing group id to which this slot belongs.
CompletableFuture<?>	releaseSlot(Throwable cause) This method cancels and releases the slot and all its sub-slots.
void	setLocality(Locality locality) Attached locality information to this slot.
String	toString()
boolean	tryAssignPayload(LogicalSlot.Payload payload) Atomically sets the executed vertex, if no vertex has been assigned to this slot so far.

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

equals, getGroupID, getOwner, getParent, getRoot, getRootSlotNumber, getSlotContext, getSlotNumber, getTaskManagerGateway, getTaskManagerID, getTaskManagerLocation, hashCode, hierarchy, isAlive, isCanceled, isReleased

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.runtime.jobmaster.LogicalSlot

getTaskManagerGateway, getTaskManagerLocation, isAlive, releaseSlot

Constructor Detail

SimpleSlot

public SimpleSlot(SlotOwner owner,
                  TaskManagerLocation location,
                  int slotNumber,
                  TaskManagerGateway taskManagerGateway)

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

Parameters:

owner - The component from which this slot is allocated.

location - The location info of the TaskManager where the slot was allocated from

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

taskManagerGateway - The gateway to communicate with the TaskManager of this slot

SimpleSlot

public SimpleSlot(SlotOwner owner,
                  TaskManagerLocation location,
                  int slotNumber,
                  TaskManagerGateway taskManagerGateway,
                  @Nullable
                  SharedSlot parent,
                  @Nullable
                  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:

owner - The component from which this slot is allocated.

location - The location info of the TaskManager where the slot was allocated from

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

taskManagerGateway - to communicate with the associated task manager.

parent - The parent shared slot.

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

SimpleSlot

public SimpleSlot(SlotContext slotContext,
                  SlotOwner owner,
                  int slotNumber)

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

Parameters:

slotContext - The slot context of this simple slot

owner - The component from which this slot is allocated.

SimpleSlot

public SimpleSlot(SharedSlot parent,
                  SlotOwner owner,
                  int slotNumber,
                  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:

parent - The parent shared slot.

owner - The component from which this slot is allocated.

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.

tryAssignPayload

public boolean tryAssignPayload(LogicalSlot.Payload payload)

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

Specified by:

tryAssignPayload in interface LogicalSlot

Parameters:

payload - The vertex to assign to this slot.

Returns:

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

getPayload

@Nullable
public LogicalSlot.Payload getPayload()

Description copied from interface: LogicalSlot

Returns the set payload or null if none.

Specified by:

getPayload in interface LogicalSlot

Returns:

Payload of this slot of null if none

getLocality

public Locality getLocality()

Gets the locality information attached to this slot.

Specified by:

getLocality in interface LogicalSlot

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 CompletableFuture<?> releaseSlot(@Nullable
                                        Throwable cause)

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 interface LogicalSlot

Specified by:

releaseSlot in class Slot

Parameters:

cause - why the slot was released or null if none

Returns:

future which is completed once the slot has been released

getPhysicalSlotNumber

public int getPhysicalSlotNumber()

Description copied from interface: LogicalSlot

Gets the slot number on the TaskManager.

Specified by:

getPhysicalSlotNumber in interface LogicalSlot

Returns:

slot number

getAllocationId

public AllocationID getAllocationId()

Description copied from interface: LogicalSlot

Gets the allocation id of this slot.

Specified by:

getAllocationId in interface LogicalSlot

Returns:

allocation id of this slot

getSlotRequestId

public SlotRequestId getSlotRequestId()

Description copied from interface: LogicalSlot

Gets the slot request id uniquely identifying the request with which this slot has been allocated.

Specified by:

getSlotRequestId in interface LogicalSlot

Returns:

Unique id identifying the slot request with which this slot was allocated

getSlotSharingGroupId

@Nullable
public SlotSharingGroupId getSlotSharingGroupId()

Description copied from interface: LogicalSlot

Gets the slot sharing group id to which this slot belongs.

Specified by:

getSlotSharingGroupId in interface LogicalSlot

Returns:

slot sharing group id of this slot or null, if none.

toString

public String toString()

Overrides:

toString in class Slot