io.temporal.internal.common

Class AsyncBackoffThrottler

java.lang.Object

io.temporal.internal.common.AsyncBackoffThrottler

public final class AsyncBackoffThrottler
extends java.lang.Object

Used to throttle code execution in presence of failures using exponential backoff logic. The formula used to calculate the next sleep interval is:

 min(pow(backoffCoefficient, failureCount - 1) * initialSleep, maxSleep);
 

Example usage:

 BackoffThrottler throttler = new BackoffThrottler(1000, 60000, 2);
 while(!stopped) {
     try {
         Future<Void> t = throttler.throttle();
         t.get();
         // some code that can fail and should be throttled
         ...
         throttler.success();
     }
     catch (Exception e) {
         throttler.failure();
     }
 }
 

Constructor Summary

Constructors

Constructor and Description
AsyncBackoffThrottler(java.time.Duration initialSleep, java.time.Duration maxSleep, double backoffCoefficient) Construct an instance of the throttler.

Method Summary

Modifier and Type	Method and Description
void	failure() Increment failure count.
void	success() Resent failure count to 0.
java.util.concurrent.CompletableFuture<java.lang.Void>	throttle() Result future is done after a delay if there were failures since the last success call.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncBackoffThrottler

public AsyncBackoffThrottler(java.time.Duration initialSleep,
                             java.time.Duration maxSleep,
                             double backoffCoefficient)

Construct an instance of the throttler.

Parameters:

initialSleep - time to sleep on the first failure

maxSleep - maximum time to sleep independently of number of failures

backoffCoefficient - coefficient used to calculate the next time to sleep.

Method Detail

throttle

public java.util.concurrent.CompletableFuture<java.lang.Void> throttle()

Result future is done after a delay if there were failures since the last success call.

success

public void success()

Resent failure count to 0.

failure

public void failure()

Increment failure count.