backoff

Documentation

Index

• func CheckRetry(r Retrier) bool
• func Retry(f Retryable, p RetryPolicy, isRetryable IsErrorRetryable) error
• type IsErrorRetryable
• type Retrier
  • func NewRetrier(policy RetryPolicy) Retrier
• type RetryPolicy
  • func NewRetryPolicy(maxAttempts int, retryInterval time.Duration) RetryPolicy
• type Retryable

Functions

func CheckRetry

func CheckRetry(r Retrier) bool

CheckRetry checks if retry is allowed, and if it is allowed, it will sleep for the backoff duration. It is used when the function to be retried takes in arguments or returns a result.

func Retry

func Retry(f Retryable, p RetryPolicy, isRetryable IsErrorRetryable) error

Retry will retry the given function until it succeeded or hit maximum number of retries then return last error.

Types

type IsErrorRetryable

type IsErrorRetryable func(error) bool

IsErrorRetryable could be used to exclude certain errors during retry

type Retrier

type Retrier interface {
	NextBackOff() time.Duration
}

Retrier is interface for managing backoff.

func NewRetrier

func NewRetrier(policy RetryPolicy) Retrier

NewRetrier is used for creating a new instance of Retrier

type RetryPolicy

type RetryPolicy interface {
	CalculateNextDelay(attempts int) time.Duration
}

RetryPolicy is interface for defining retry policy.

func NewRetryPolicy

func NewRetryPolicy(maxAttempts int, retryInterval time.Duration) RetryPolicy

NewRetryPolicy is used to create a new instance or RetryPolicy.

type Retryable

type Retryable func() error

Retryable is a function returning an error which can be retried.