org.apache.flink.runtime.jobmaster.slotpool

Class SchedulerImpl

java.lang.Object

org.apache.flink.runtime.jobmaster.slotpool.SchedulerImpl

All Implemented Interfaces:

SlotOwner, Scheduler, SlotProvider

public class SchedulerImpl
extends Object
implements Scheduler

Scheduler that assigns tasks to slots. This class is currently work in progress, comments will be updated as we move forward.

Constructor Summary

Constructors

Constructor and Description
SchedulerImpl(SlotSelectionStrategy slotSelectionStrategy, SlotPool slotPool)
SchedulerImpl(SlotSelectionStrategy slotSelectionStrategy, SlotPool slotPool, Map<SlotSharingGroupId,SlotSharingManager> slotSharingManagers)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<LogicalSlot>	allocateBatchSlot(SlotRequestId slotRequestId, ScheduledUnit scheduledUnit, SlotProfile slotProfile) Allocating batch slot with specific requirement.
CompletableFuture<LogicalSlot>	allocateSlot(SlotRequestId slotRequestId, ScheduledUnit scheduledUnit, SlotProfile slotProfile, Time allocationTimeout) Allocating slot with specific requirement.
void	cancelSlotRequest(SlotRequestId slotRequestId, SlotSharingGroupId slotSharingGroupId, Throwable cause) Cancels the slot request with the given SlotRequestId and SlotSharingGroupId.
boolean	requiresPreviousExecutionGraphAllocations() Returns true, iff the scheduling strategy of the scheduler requires to know about previous allocations.
void	returnLogicalSlot(LogicalSlot logicalSlot) Return the given slot to the slot owner.
void	start(ComponentMainThreadExecutor mainThreadExecutor) Start the scheduler by initializing the main thread executor.

Methods inherited from class java.lang.Object

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

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

allocateSlot

Constructor Detail

SchedulerImpl

public SchedulerImpl(@Nonnull
                     SlotSelectionStrategy slotSelectionStrategy,
                     @Nonnull
                     SlotPool slotPool)

SchedulerImpl

@VisibleForTesting
public SchedulerImpl(@Nonnull
                                        SlotSelectionStrategy slotSelectionStrategy,
                                        @Nonnull
                                        SlotPool slotPool,
                                        @Nonnull
                                        Map<SlotSharingGroupId,SlotSharingManager> slotSharingManagers)

Method Detail

start

public void start(@Nonnull
                  ComponentMainThreadExecutor mainThreadExecutor)

Description copied from interface: Scheduler

Start the scheduler by initializing the main thread executor.

Specified by:

start in interface Scheduler

Parameters:

mainThreadExecutor - the main thread executor of the job master.

allocateSlot

public CompletableFuture<LogicalSlot> allocateSlot(SlotRequestId slotRequestId,
                                                   ScheduledUnit scheduledUnit,
                                                   SlotProfile slotProfile,
                                                   Time allocationTimeout)

Description copied from interface: SlotProvider

Allocating slot with specific requirement.

Specified by:

allocateSlot in interface SlotProvider

Parameters:

slotRequestId - identifying the slot request

scheduledUnit - The task to allocate the slot for

slotProfile - profile of the requested slot

allocationTimeout - after which the allocation fails with a timeout exception

Returns:

The future of the allocation

allocateBatchSlot

public CompletableFuture<LogicalSlot> allocateBatchSlot(SlotRequestId slotRequestId,
                                                        ScheduledUnit scheduledUnit,
                                                        SlotProfile slotProfile)

Description copied from interface: SlotProvider

Allocating batch slot with specific requirement.

Specified by:

allocateBatchSlot in interface SlotProvider

Parameters:

slotRequestId - identifying the slot request

scheduledUnit - The task to allocate the slot for

slotProfile - profile of the requested slot

Returns:

The future of the allocation

cancelSlotRequest

public void cancelSlotRequest(SlotRequestId slotRequestId,
                              @Nullable
                              SlotSharingGroupId slotSharingGroupId,
                              Throwable cause)

Description copied from interface: SlotProvider

Cancels the slot request with the given SlotRequestId and SlotSharingGroupId.

Specified by:

cancelSlotRequest in interface SlotProvider

Parameters:

slotRequestId - identifying the slot request to cancel

slotSharingGroupId - identifying the slot request to cancel

cause - of the cancellation

returnLogicalSlot

public void returnLogicalSlot(LogicalSlot logicalSlot)

Description copied from interface: SlotOwner

Return the given slot to the slot owner.

Specified by:

returnLogicalSlot in interface SlotOwner

Parameters:

logicalSlot - to return

requiresPreviousExecutionGraphAllocations

public boolean requiresPreviousExecutionGraphAllocations()

Description copied from interface: Scheduler

Returns true, iff the scheduling strategy of the scheduler requires to know about previous allocations.

Specified by:

requiresPreviousExecutionGraphAllocations in interface Scheduler