org.apache.flink.runtime.jobmaster.slotpool

Interface SlotPoolGateway

All Superinterfaces:

AllocatedSlotActions, RpcGateway

All Known Implementing Classes:

SlotPool

public interface SlotPoolGateway
extends AllocatedSlotActions, RpcGateway

The gateway for calls on the SlotPool.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<LogicalSlot>	allocateSlot(SlotRequestId slotRequestId, ScheduledUnit scheduledUnit, SlotProfile slotProfile, boolean allowQueuedScheduling, Time timeout) Requests to allocate a slot for the given ScheduledUnit.
void	connectToResourceManager(ResourceManagerGateway resourceManagerGateway) Connects the SlotPool to the given ResourceManager.
void	disconnectResourceManager() Disconnects the slot pool from its current Resource Manager.
void	failAllocation(AllocationID allocationID, Exception cause) Fails the slot with the given allocation id.
CompletableFuture<Boolean>	offerSlot(TaskManagerLocation taskManagerLocation, TaskManagerGateway taskManagerGateway, SlotOffer slotOffer) Offers a slot to the SlotPool.
CompletableFuture<Collection<SlotOffer>>	offerSlots(TaskManagerLocation taskManagerLocation, TaskManagerGateway taskManagerGateway, Collection<SlotOffer> offers) Offers multiple slots to the SlotPool.
CompletableFuture<Acknowledge>	registerTaskManager(ResourceID resourceID) Registers a TaskExecutor with the given ResourceID at SlotPool.
CompletableFuture<Acknowledge>	releaseTaskManager(ResourceID resourceId, Exception cause) Releases a TaskExecutor with the given ResourceID from the SlotPool.
void	suspend()

Methods inherited from interface org.apache.flink.runtime.jobmaster.slotpool.AllocatedSlotActions

releaseSlot

Methods inherited from interface org.apache.flink.runtime.rpc.RpcGateway

getAddress, getHostname

Method Detail

suspend

void suspend()

connectToResourceManager

void connectToResourceManager(ResourceManagerGateway resourceManagerGateway)

Connects the SlotPool to the given ResourceManager. After this method is called, the SlotPool will be able to request resources from the given ResourceManager.

Parameters:

resourceManagerGateway - The RPC gateway for the resource manager.

disconnectResourceManager

void disconnectResourceManager()

Disconnects the slot pool from its current Resource Manager. After this call, the pool will not be able to request further slots from the Resource Manager, and all currently pending requests to the resource manager will be canceled.

The slot pool will still be able to serve slots from its internal pool.

registerTaskManager

CompletableFuture<Acknowledge> registerTaskManager(ResourceID resourceID)

Registers a TaskExecutor with the given ResourceID at SlotPool.

Parameters:

resourceID - identifying the TaskExecutor to register

Returns:

Future acknowledge which is completed after the TaskExecutor has been registered

releaseTaskManager

CompletableFuture<Acknowledge> releaseTaskManager(ResourceID resourceId,
                                                  Exception cause)

Releases a TaskExecutor with the given ResourceID from the SlotPool.

Parameters:

resourceId - identifying the TaskExecutor which shall be released from the SlotPool

cause - for the releasing of the TaskManager

Returns:

Future acknowledge which is completed after the TaskExecutor has been released

offerSlot

CompletableFuture<Boolean> offerSlot(TaskManagerLocation taskManagerLocation,
                                     TaskManagerGateway taskManagerGateway,
                                     SlotOffer slotOffer)

Offers a slot to the SlotPool. The slot offer can be accepted or rejected.

Parameters:

taskManagerLocation - from which the slot offer originates

taskManagerGateway - to talk to the slot offerer

slotOffer - slot which is offered to the SlotPool

Returns:

True (future) if the slot has been accepted, otherwise false (future)

offerSlots

CompletableFuture<Collection<SlotOffer>> offerSlots(TaskManagerLocation taskManagerLocation,
                                                    TaskManagerGateway taskManagerGateway,
                                                    Collection<SlotOffer> offers)

Offers multiple slots to the SlotPool. The slot offerings can be individually accepted or rejected by returning the collection of accepted slot offers.

Parameters:

taskManagerLocation - from which the slot offers originate

taskManagerGateway - to talk to the slot offerer

offers - slot offers which are offered to the SlotPool

Returns:

A collection of accepted slot offers (future). The remaining slot offers are implicitly rejected.

failAllocation

void failAllocation(AllocationID allocationID,
                    Exception cause)

Fails the slot with the given allocation id.

Parameters:

allocationID - identifying the slot which is being failed

cause - of the failure

allocateSlot

CompletableFuture<LogicalSlot> allocateSlot(SlotRequestId slotRequestId,
                                            ScheduledUnit scheduledUnit,
                                            SlotProfile slotProfile,
                                            boolean allowQueuedScheduling,
                                            Time timeout)

Requests to allocate a slot for the given ScheduledUnit. The request is uniquely identified by the provided SlotRequestId which can also be used to release the slot via AllocatedSlotActions.releaseSlot(SlotRequestId, SlotSharingGroupId, Throwable). The allocated slot will fulfill the requested ResourceProfile and it is tried to place it on one of the location preferences.

If the returned future must not be completed right away (a.k.a. the slot request can be queued), allowQueuedScheduling must be set to true.

Parameters:

slotRequestId - identifying the requested slot

scheduledUnit - for which to allocate slot

slotProfile - profile that specifies the requirements for the requested slot

allowQueuedScheduling - true if the slot request can be queued (e.g. the returned future must not be completed)

timeout - for the operation

Returns:

Future which is completed with the allocated LogicalSlot