Package io.aiven.kafka.connect.common.source

Class AbstractSourceTask.Backoff

java.lang.Object

io.aiven.kafka.connect.common.source.AbstractSourceTask.Backoff

Enclosing class:

AbstractSourceTask

public static class AbstractSourceTask.Backoff
extends Object

Performs a delay based on the number of successive delay() or cleanDelay() calls without a reset(). Delay increases exponentially but never exceeds the time remaining by more than 0.512 seconds.

Field Summary

Fields

Modifier and Type	Field	Description
protected final AbstractSourceTask.AbortTrigger	abortTrigger	A function to call to abort the timer.
static final int	JITTER_SUBTRAHEND
static final int	MAX_JITTER	The maximum jitter random number.
protected final AbstractSourceTask.SupplierOfLong	timeRemaining	A supplier of the time remaining (in milliseconds) on the overriding timer.

Constructor Summary

Constructors

Constructor	Description
Backoff(AbstractSourceTask.BackoffConfig config)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	cleanDelay()	Like delay() but swallows the InterruptedException.
void	delay()	Delay execution based on the number of times this method has been called.
long	estimatedDelay()	Calculates the delay without jitter.
int	getMaxJitter()	Calculates the range of jitter in milliseconds.
final void	reset()	Reset the backoff time so that delay is again at the minimum.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

MAX_JITTER

public static final int MAX_JITTER

The maximum jitter random number. Should be a power of 2 for speed.

See Also:

• Constant Field Values

JITTER_SUBTRAHEND

public static final int JITTER_SUBTRAHEND

See Also:

• Constant Field Values

timeRemaining

protected final AbstractSourceTask.SupplierOfLong timeRemaining

A supplier of the time remaining (in milliseconds) on the overriding timer.

abortTrigger

protected final AbstractSourceTask.AbortTrigger abortTrigger

A function to call to abort the timer.

Constructor Details

Backoff

public Backoff(AbstractSourceTask.BackoffConfig config)

Constructor.

Parameters:

config - The configuration for the backoff.

Method Details

reset

public final void reset()

Reset the backoff time so that delay is again at the minimum.

estimatedDelay

public long estimatedDelay()

Calculates the delay without jitter.

Returns:

the number of milliseconds the delay will be.

getMaxJitter

public int getMaxJitter()

Calculates the range of jitter in milliseconds.

Returns:

the maximum jitter in milliseconds. jitter is +/- maximum jitter.

delay

public void delay()
           throws InterruptedException

Delay execution based on the number of times this method has been called.

Throws:

InterruptedException - If any thread interrupts this thread.

cleanDelay

public void cleanDelay()

Like delay() but swallows the InterruptedException.

toString

public String toString()

Overrides:

toString in class Object