Skip to content

MINOR: ExponentialBackoff Javadoc improvements #13317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
C0urante merged 1 commit into from
Feb 28, 2023
Merged

MINOR: ExponentialBackoff Javadoc improvements #13317

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions clients/src/main/java/org/apache/kafka/common/utils/ExponentialBackoff.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,15 @@
import java.util.concurrent.ThreadLocalRandom;

/**
* An utility class for keeping the parameters and providing the value of exponential
* A utility class for keeping the parameters and providing the value of exponential
* retry backoff, exponential reconnect backoff, exponential timeout, etc.
* <p>
* The formula is:
* Backoff(attempts) = random(1 - jitter, 1 + jitter) * initialInterval * multiplier ^ attempts
* If initialInterval is greater or equal than maxInterval, a constant backoff of will be provided
* This class is thread-safe
* <pre>Backoff(attempts) = random(1 - jitter, 1 + jitter) * initialInterval * multiplier ^ attempts</pre>
* If {@code initialInterval} is greater than or equal to {@code maxInterval}, a constant backoff of
* {@code initialInterval} will be provided.
* <p>
* This class is thread-safe.
*/
public class ExponentialBackoff {
private final int multiplier;
Expand Down