Class SlotSupplierFuture

java.lang.Object

java.util.concurrent.CompletableFuture<SlotPermit>

io.temporal.worker.tuning.SlotSupplierFuture

All Implemented Interfaces:

CompletionStage<SlotPermit>, Future<SlotPermit>

public abstract class SlotSupplierFuture
extends CompletableFuture<SlotPermit>

Represents a future that will be completed with a SlotPermit when a slot is available.

This class exists to provide a reliable cancellation mechanism, since CompletableFuture does not provide cancellations that properly propagate up the chain.

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.CompletableFuture

CompletableFuture.AsynchronousCompletionTask

Nested classes/interfaces inherited from interface java.util.concurrent.Future

Future.State

Constructor Summary

Constructors

Constructor	Description
SlotSupplierFuture()

Method Summary

Modifier and Type	Method	Description
abstract SlotPermit	abortReservation()	Abort the reservation attempt.
boolean	cancel(boolean mayInterruptIfRunning)
static SlotSupplierFuture	completedFuture(SlotPermit permit)	See CompletableFuture.completedFuture(Object)
static SlotSupplierFuture	fromCompletableFuture(CompletableFuture<SlotPermit> future, Runnable abortHandler)	Create a new SlotSupplierFuture from a CompletableFuture

Methods inherited from class java.util.concurrent.CompletableFuture

acceptEither, acceptEitherAsync, acceptEitherAsync, allOf, anyOf, applyToEither, applyToEitherAsync, applyToEitherAsync, complete, completeAsync, completeAsync, completedFuture, completedStage, completeExceptionally, completeOnTimeout, copy, defaultExecutor, delayedExecutor, delayedExecutor, exceptionally, exceptionallyAsync, exceptionallyAsync, exceptionallyCompose, exceptionallyComposeAsync, exceptionallyComposeAsync, exceptionNow, failedFuture, failedStage, get, get, getNow, getNumberOfDependents, handle, handleAsync, handleAsync, isCancelled, isCompletedExceptionally, isDone, join, minimalCompletionStage, newIncompleteFuture, obtrudeException, obtrudeValue, orTimeout, resultNow, runAfterBoth, runAfterBothAsync, runAfterBothAsync, runAfterEither, runAfterEitherAsync, runAfterEitherAsync, runAsync, runAsync, state, supplyAsync, supplyAsync, thenAccept, thenAcceptAsync, thenAcceptAsync, thenAcceptBoth, thenAcceptBothAsync, thenAcceptBothAsync, thenApply, thenApplyAsync, thenApplyAsync, thenCombine, thenCombineAsync, thenCombineAsync, thenCompose, thenComposeAsync, thenComposeAsync, thenRun, thenRunAsync, thenRunAsync, toCompletableFuture, toString, whenComplete, whenCompleteAsync, whenCompleteAsync

Methods inherited from class java.lang.Object

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

Constructor Details

SlotSupplierFuture

public SlotSupplierFuture()

Method Details

abortReservation

@Nullable
@CheckReturnValue
public abstract SlotPermit abortReservation()

Abort the reservation attempt. Direct implementations should cancel or interrupt any underlying processes that are attempting to reserve a slot.

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<SlotPermit>

Overrides:

cancel in class CompletableFuture<SlotPermit>

completedFuture

public static SlotSupplierFuture completedFuture(SlotPermit permit)

See CompletableFuture.completedFuture(Object)

fromCompletableFuture

public static SlotSupplierFuture fromCompletableFuture(CompletableFuture<SlotPermit> future,
 Runnable abortHandler)

Create a new SlotSupplierFuture from a CompletableFuture

Parameters:

abortHandler - The handler to call when the reservation is aborted. This should abort the furthest-upstream future, or call being waited on, in order to properly propagate cancellation downstream.