retry

Documentation

Index

• func WaitTime(attempt int, random *rand.Rand) time.Duration
• type NonRetryableError
  • func (e *NonRetryableError) Error() string
  • func (e *NonRetryableError) Unwrap() error
• type Retry
  • func NewRetry(maxRetry int, seed int64) Retry
  • func NewTestRetry(maxRetry int) Retry
  • func (r Retry) Do(ctx context.Context, f func(context.Context) error, desc string) error

Functions

func WaitTime

func WaitTime(attempt int, random *rand.Rand) time.Duration

WaitTime calculates the wait time based off the attempt number based off exponential backoff with a random delay. It caps at the constant maxWaitTime.

Types

type NonRetryableError

type NonRetryableError struct {
	Err error
}

NonRetryableError represents an error returned if the error should not be retried

func (*NonRetryableError) Error

func (e *NonRetryableError) Error() string

Error returns an error string

func (*NonRetryableError) Unwrap

func (e *NonRetryableError) Unwrap() error

Unwrap returns the underlying error

type Retry

type Retry struct {
	// contains filtered or unexported fields
}

Retry handles executing and retrying a function

func NewRetry

func NewRetry(maxRetry int, seed int64) Retry

NewRetry initializes a retry handler maxRetry is *retries*, so maxRetry of 2 means 3 total tries. -1 retries means indefinite retries

func NewTestRetry

func NewTestRetry(maxRetry int) Retry

NewTestRetry is the test version, returns Retry in test mode (nanosecond retry delay).

func (Retry) Do

func (r Retry) Do(ctx context.Context, f func(context.Context) error, desc string) error

Do calls a function with exponential retries with a random delay.