retry

Documentation

Index

• func IfNecessary(ctx context.Context, operation func() error, options *Options) error
• func IsErrorRetryable(err error) bool
• func RetryIfNecessary(ctx context.Context, operation func() error, options *Options) error
• type Options
• type RetryOptions

Functions

func IfNecessary

func IfNecessary(ctx context.Context, operation func() error, options *Options) error

IfNecessary retries the operation in exponential backoff with the retry Options.

func IsErrorRetryable

func IsErrorRetryable(err error) bool

IsErrorRetryable makes a HEURISTIC determination whether it is worth retrying upon encountering an error. That heuristic is NOT STABLE and it CAN CHANGE AT ANY TIME. Callers that have a hard requirement for specific treatment of a class of errors should make their own check instead of relying on this function maintaining its past behavior.

func RetryIfNecessary

func RetryIfNecessary(ctx context.Context, operation func() error, options *Options) error

RetryIfNecessary deprecated function use IfNecessary.

Types

type Options

type Options struct {
	MaxRetry         int           // The number of times to possibly retry.
	Delay            time.Duration // The delay to use between retries, if set.
	IsErrorRetryable func(error) bool
}

Options defines the option to retry.

type RetryOptions

type RetryOptions = Options // nolint:revive

RetryOptions is deprecated, use Options.