retry

Documentation

Index

• func WithMaxAttempts(ctx context.Context, opts Options, n int, fn func() error) error
• type Options
• type Retry
  • func Start(opts Options) Retry
  • func StartWithCtx(ctx context.Context, opts Options) Retry
  • func (r *Retry) Next() bool
  • func (r *Retry) NextCh() <-chan time.Time
  • func (r *Retry) Reset()

Functions

func WithMaxAttempts

func WithMaxAttempts(ctx context.Context, opts Options, n int, fn func() error) error

WithMaxAttempts is a helper that runs fn N times and collects the last err.

Types

type Options

type Options struct {
	InitialBackoff      time.Duration   // Default retry backoff interval
	MaxBackoff          time.Duration   // Maximum retry backoff interval
	Multiplier          float64         // Default backoff constant
	MaxRetries          int             // Maximum number of attempts (0 for infinite)
	RandomizationFactor float64         // Randomize the backoff interval by constant
	Closer              <-chan struct{} // Optionally end retry loop channel close.
}

Options provides reusable configuration of Retry objects.

type Retry

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

Retry implements the public methods necessary to control an exponential- backoff retry loop.

func Start

func Start(opts Options) Retry

Start returns a new Retry initialized to some default values. The Retry can then be used in an exponential-backoff retry loop.

func StartWithCtx

func StartWithCtx(ctx context.Context, opts Options) Retry

StartWithCtx returns a new Retry initialized to some default values. The Retry can then be used in an exponential-backoff retry loop. If the provided context is canceled (see Context.Done), the retry loop ends early.

func (*Retry) Next

func (r *Retry) Next() bool

Next returns whether the retry loop should continue, and blocks for the appropriate length of time before yielding back to the caller. If a stopper is present, Next will eagerly return false when the stopper is stopped.

func (*Retry) NextCh

func (r *Retry) NextCh() <-chan time.Time

NextCh returns a channel which will receive when the next retry interval has expired.

func (*Retry) Reset

func (r *Retry) Reset()

Reset resets the Retry to its initial state, meaning that the next call to Next will return true immediately and subsequent calls will behave as if they had followed the very first attempt (i.e. their backoffs will be short).