de.fhg.fokus.xtensions.concurrent

Class CompletableFutureExtensions.TimeoutConfig

java.lang.Object

de.fhg.fokus.xtensions.concurrent.CompletableFutureExtensions.TimeoutConfig

Enclosing class:

CompletableFutureExtensions

public static final class CompletableFutureExtensions.TimeoutConfig
extends Object

An instance of this class will be passed to the configuration block passed to the orTimeout(CompletableFuture<R>, (TimeoutConfig)=>void) extension method.

Method Summary

Modifier and Type	Method and Description
void	setBackwardPropagateCancel(boolean cancelPropagation) If this method is called with true, canceling the created timeout future will try to cancel the original future. Default value is false
void	setCancelOriginalOnTimeout(boolean cancelOriginalOnTimeout) If this method is called with true, the original future will be tried to be canceled if the created timeout future will cancelled. Default value is false
void	setExceptionProvider(Functions.Function0<? extends Throwable> exceptionProvider) Sets the provider of an exception that will be called on timeout.
void	setScheduler(ScheduledExecutorService scheduler) Sets the scheduler used to schedule the timeout operation.
void	setTimeout(Duration timeout) Sets the time duration after which the timeout operation is triggered. Default value is 1 second.
void	setTimeout(Pair<Long,TimeUnit> timeout) Sets the time duration after which the timeout operation is triggered. Default value is 1 second.
void	setTryShutdownScheduler(boolean doShutdown) Defines if the scheduler for cancellation operation should be shut down after the original future completes or a timeout occurs.

Methods inherited from class java.lang.Object

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

Method Detail

setTimeout

public void setTimeout(Pair<Long,TimeUnit> timeout)

Sets the time duration after which the timeout operation is triggered.
Default value is 1 second.

Parameters:

timeout - Pair of time amount and time unit of duration of timeout.

setTimeout

public void setTimeout(Duration timeout)

Sets the time duration after which the timeout operation is triggered.
Default value is 1 second.

Parameters:

timeout - time duration of timeout

setScheduler

public void setScheduler(ScheduledExecutorService scheduler)

Sets the scheduler used to schedule the timeout operation.
By default (if not set) a new ScheduledExecutorService is created and shut down after completion of the original future or after timeout.

Parameters:

scheduler - the scheduler used to schedule the timeout operation

setTryShutdownScheduler

public void setTryShutdownScheduler(boolean doShutdown)

Defines if the scheduler for cancellation operation should be shut down after the original future completes or a timeout occurs. Only relevant if setScheduler is used to set custom scheduler.
Default value is false.

Parameters:

doShutdown - if true the given scheduler should be shut down after the original future completes or a timeout occurs.

setExceptionProvider

public void setExceptionProvider(Functions.Function0<? extends Throwable> exceptionProvider)

Sets the provider of an exception that will be called on timeout. The provided exception will then be used to complete the future.
If not set, a new TimeoutException will be used to complete the future on timeout.

Parameters:

exceptionProvider - constructor operation to create exception to be set when timeout occurs.

setBackwardPropagateCancel

public void setBackwardPropagateCancel(boolean cancelPropagation)

If this method is called with true, canceling the created timeout future will try to cancel the original future.
Default value is false

Parameters:

cancelPropagation - if true, canceling the created timeout future will try to cancel the original future.

setCancelOriginalOnTimeout

public void setCancelOriginalOnTimeout(boolean cancelOriginalOnTimeout)

If this method is called with true, the original future will be tried to be canceled if the created timeout future will cancelled.
Default value is false

Parameters:

cancelOriginalOnTimeout - if true, the original future will be tried to be canceled if the created timeout future will cancelled.