retry

Documentation

Index

• type Backoff
  • func (lb *Backoff) Linear() time.Duration
• type Config
  • func (cfg Config) Run(ctx context.Context, fn func(context.Context) error) error
• type RetryExhaustedError
  • func (err *RetryExhaustedError) Error() string

Types

type Backoff

type Backoff struct {
	InitialBackoff time.Duration
	MaxBackoff     time.Duration
	Multiplier     float64
}

func (*Backoff) Linear

func (lb *Backoff) Linear() time.Duration

type Config

type Config struct {
	// The operation will be retried until StartTimeout has elapsed. 0 means
	// forever.
	StartTimeout time.Duration

	// RetryDelay gives the time elapsed after a failure and before we try
	// again. Returns 2s by default.
	RetryDelay func() time.Duration

	// Max number of retries, 0 means infinite
	Tries int

	// ShouldRetry tells wether error should be retried. Nil defaults to always
	// true.
	ShouldRetry func(error) bool
}

Config represents a retry config

func (Config) Run

func (cfg Config) Run(ctx context.Context, fn func(context.Context) error) error

Run fn until context is cancelled up until StartTimeout time has passed.

type RetryExhaustedError

type RetryExhaustedError struct {
	Err error
}

func (*RetryExhaustedError) Error

func (err *RetryExhaustedError) Error() string