Top Description Fields Methods
io.github.resilience4j.core

public Interface IntervalFunction

Additional top-level class in compilation unit: IntervalFunctionCompanion.

extends Function<Integer, Long>
Annotations
@FunctionalInterface
Imports
java.time.Duration, java.util.function.Function, java.util.stream.LongStream

An IntervalFunction which can be used to calculate the wait interval. The input parameter of the function is the number of attempts (attempt), the output parameter the wait interval in milliseconds. The attempt parameter starts at 1 and increases with every further attempt.

Field Summary

Modifier and TypeField and Description
public static final long
public static final double
public static final double

Method Summary

Modifier and TypeMethod and Description
public static IntervalFunction
of(long intervalMillis, Function<Long, Long> backoffFunction)

public static IntervalFunction
of(Duration interval, Function<Long, Long> backoffFunction)

public static IntervalFunction

Returns:

an IntervalFunction which returns a fixed interval in milliseconds.
of
(long
the interval in milliseconds
intervalMillis
)

Creates an IntervalFunction which returns a fixed interval in milliseconds.

public static IntervalFunction

Returns:

an IntervalFunction which returns a fixed interval specified by a given Duration.
of
(Duration
the interval
interval
)

Creates an IntervalFunction which returns a fixed interval specified by a given Duration.

public static IntervalFunction

Returns:

returns an IntervalFunction which returns a fixed default interval of 500 [ms]
ofDefaults
()

Creates an IntervalFunction which returns a fixed default interval of 500 [ms].

public static IntervalFunction
ofExponentialBackoff(long initialIntervalMillis, double multiplier, long maxIntervalMillis)

public static IntervalFunction
ofExponentialBackoff(Duration initialInterval, double multiplier, Duration maxInterval)

public static IntervalFunction
ofExponentialBackoff(long initialIntervalMillis, double multiplier)

public static IntervalFunction
ofExponentialBackoff(Duration initialInterval, double multiplier)

public static IntervalFunction
ofExponentialBackoff(long initialIntervalMillis)

public static IntervalFunction
ofExponentialBackoff(Duration initialInterval)

public static IntervalFunction
public static IntervalFunction
ofExponentialRandomBackoff(long initialIntervalMillis, double multiplier, double randomizationFactor, long maxIntervalMillis)

public static IntervalFunction
ofExponentialRandomBackoff(long initialIntervalMillis, double multiplier, double randomizationFactor)

public static IntervalFunction
ofExponentialRandomBackoff(Duration initialInterval, double multiplier, double randomizationFactor, Duration maxInterval)

public static IntervalFunction
ofExponentialRandomBackoff(Duration initialInterval, double multiplier, double randomizationFactor)

public static IntervalFunction
ofExponentialRandomBackoff(long initialIntervalMillis, double multiplier, long maxIntervalMillis)

public static IntervalFunction
ofExponentialRandomBackoff(long initialIntervalMillis, double multiplier)

public static IntervalFunction
ofExponentialRandomBackoff(Duration initialInterval, double multiplier, Duration maxInterval)

public static IntervalFunction
ofExponentialRandomBackoff(Duration initialInterval, double multiplier)

public static IntervalFunction
ofExponentialRandomBackoff(long initialIntervalMillis)

public static IntervalFunction
public static IntervalFunction
public static IntervalFunction
ofRandomized(long intervalMillis, double randomizationFactor)

public static IntervalFunction
ofRandomized(Duration interval, double randomizationFactor)

public static IntervalFunction
ofRandomized(long intervalMillis)

public static IntervalFunction
public static IntervalFunction
Inherited from java.util.function.Function:
andThenapplycomposeidentity

Field Detail

DEFAULT_INITIAL_INTERVALback to summary
public static final long DEFAULT_INITIAL_INTERVAL
DEFAULT_MULTIPLIERback to summary
public static final double DEFAULT_MULTIPLIER
DEFAULT_RANDOMIZATION_FACTORback to summary
public static final double DEFAULT_RANDOMIZATION_FACTOR

Method Detail

ofback to summary
public static IntervalFunction of(long intervalMillis, Function<Long, Long> backoffFunction)
ofback to summary
public static IntervalFunction of(Duration interval, Function<Long, Long> backoffFunction)
ofback to summary
public static IntervalFunction of(long intervalMillis)

Creates an IntervalFunction which returns a fixed interval in milliseconds.

Parameters
intervalMillis:long

the interval in milliseconds

Returns:IntervalFunction

an IntervalFunction which returns a fixed interval in milliseconds.

ofback to summary
public static IntervalFunction of(Duration interval)

Creates an IntervalFunction which returns a fixed interval specified by a given Duration.

Parameters
interval:Duration

the interval

Returns:IntervalFunction

an IntervalFunction which returns a fixed interval specified by a given Duration.

ofDefaultsback to summary
public static IntervalFunction ofDefaults()

Creates an IntervalFunction which returns a fixed default interval of 500 [ms].

Returns:IntervalFunction

returns an IntervalFunction which returns a fixed default interval of 500 [ms]

ofExponentialBackoffback to summary
public static IntervalFunction ofExponentialBackoff(long initialIntervalMillis, double multiplier, long maxIntervalMillis)
ofExponentialBackoffback to summary
public static IntervalFunction ofExponentialBackoff(Duration initialInterval, double multiplier, Duration maxInterval)
ofExponentialBackoffback to summary
public static IntervalFunction ofExponentialBackoff(long initialIntervalMillis, double multiplier)
ofExponentialBackoffback to summary
public static IntervalFunction ofExponentialBackoff(Duration initialInterval, double multiplier)
ofExponentialBackoffback to summary
public static IntervalFunction ofExponentialBackoff(long initialIntervalMillis)
ofExponentialBackoffback to summary
public static IntervalFunction ofExponentialBackoff(Duration initialInterval)
ofExponentialBackoffback to summary
public static IntervalFunction ofExponentialBackoff()
ofExponentialRandomBackoffback to summary
public static IntervalFunction ofExponentialRandomBackoff(long initialIntervalMillis, double multiplier, double randomizationFactor, long maxIntervalMillis)
ofExponentialRandomBackoffback to summary
public static IntervalFunction ofExponentialRandomBackoff(long initialIntervalMillis, double multiplier, double randomizationFactor)
ofExponentialRandomBackoffback to summary
public static IntervalFunction ofExponentialRandomBackoff(Duration initialInterval, double multiplier, double randomizationFactor, Duration maxInterval)
ofExponentialRandomBackoffback to summary
public static IntervalFunction ofExponentialRandomBackoff(Duration initialInterval, double multiplier, double randomizationFactor)
ofExponentialRandomBackoffback to summary
public static IntervalFunction ofExponentialRandomBackoff(long initialIntervalMillis, double multiplier, long maxIntervalMillis)
ofExponentialRandomBackoffback to summary
public static IntervalFunction ofExponentialRandomBackoff(long initialIntervalMillis, double multiplier)
ofExponentialRandomBackoffback to summary
public static IntervalFunction ofExponentialRandomBackoff(Duration initialInterval, double multiplier, Duration maxInterval)
ofExponentialRandomBackoffback to summary
public static IntervalFunction ofExponentialRandomBackoff(Duration initialInterval, double multiplier)
ofExponentialRandomBackoffback to summary
public static IntervalFunction ofExponentialRandomBackoff(long initialIntervalMillis)
ofExponentialRandomBackoffback to summary
public static IntervalFunction ofExponentialRandomBackoff(Duration initialInterval)
ofExponentialRandomBackoffback to summary
public static IntervalFunction ofExponentialRandomBackoff()
ofRandomizedback to summary
public static IntervalFunction ofRandomized(long intervalMillis, double randomizationFactor)
ofRandomizedback to summary
public static IntervalFunction ofRandomized(Duration interval, double randomizationFactor)
ofRandomizedback to summary
public static IntervalFunction ofRandomized(long intervalMillis)
ofRandomizedback to summary
public static IntervalFunction ofRandomized(Duration interval)
ofRandomizedback to summary
public static IntervalFunction ofRandomized()