BaseRetryPolicy (Pinot Service Provider Interface 0.12.1 API)

java.lang.Object
- org.apache.pinot.spi.utils.retry.BaseRetryPolicy

All Implemented Interfaces:

RetryPolicy

Direct Known Subclasses:

ExponentialBackoffRetryPolicy, FixedDelayRetryPolicy, NoDelayRetryPolicy, RandomDelayRetryPolicy
```
public abstract class BaseRetryPolicy
extends Object
implements RetryPolicy
```
The BaseRetryPolicy is the base class for all retry policies. To implement a new retry policy, extends this class and implements the method getDelayMs(int).
NOTE: All the retry policies should be stateless so that they can be cached and reused.

Constructor Summary

Constructors
Modifier Constructor Description

protected BaseRetryPolicy(int maxNumAttempts)

Method Summary

Modifier and Type	Method	Description
`void`	`attempt(Callable<Boolean> operation)`	Attempts to do the operation until it succeeds, aborting if an exception is thrown by the operation or number of attempts exhausted.
`protected abstract long`	`getDelayMs(int currentAttempt)`	Gets the delay in milliseconds before the next attempt.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BaseRetryPolicy
```
protected BaseRetryPolicy(int maxNumAttempts)
```
- Method Detail
  - getDelayMs
```
protected abstract long getDelayMs(int currentAttempt)
```
    Gets the delay in milliseconds before the next attempt.
    
    Parameters:
    
    currentAttempt - Current attempt number
    
    Returns:
    
    Delay in milliseconds
  - attempt
```
public void attempt(Callable<Boolean> operation)
             throws AttemptsExceededException,
                    RetriableOperationException
```
    Description copied from interface: RetryPolicy
    
    Attempts to do the operation until it succeeds, aborting if an exception is thrown by the operation or number of attempts exhausted.
    
    Specified by:
    
    attempt in interface RetryPolicy
    
    Parameters:
    
    operation - The operation to attempt, which returns true on success and false on failure.
    
    Throws:
    
    AttemptsExceededException
    
    RetriableOperationException