retry

Documentation

Index

• Constants
• Variables
• func Disable(err error) error
• func Retryable(err error) bool
• type Policy
  • func Basic() Policy
  • func Long() Policy
  • func (retry Policy) MaxDelay() time.Duration
  • func (policy Policy) Retrier() Retrier
  • func (policy Policy) RetrierContext(ctx context.Context) Retrier
  • func (policy Policy) Run(f func() error) (err error)
  • func (policy Policy) RunContext(ctx context.Context, f func() error) (err error)
  • func (retry Policy) Step(step *int, delay *time.Duration) error
  • func (retry Policy) StepN(n int) (delay time.Duration, err error)
  • func (retry Policy) WithDefaults() Policy
• type Retrier
  • func (retry *Retrier) Consume(err error) error
  • func (retry *Retrier) ConsumeAny() error
  • func (retry *Retrier) NextDelay() (delay time.Duration, err error)
  • func (retry Retrier) Run(f func() error) (err error)

Constants

const RetrierMaxDelayCoeff = 20

Variables

var ErrDeadlineExceeded = errors.New("deadline exceeded")

var ErrMaxAttemptsExceeded = errors.New("max attempts exceeded")

Functions

func Disable

func Disable(err error) error

func Retryable

func Retryable(err error) bool

Types

type Policy

type Policy struct {
	Attempts int           `json:"attempts,omitempty" yaml:"attempts,omitempty"` // The maximum number of retries.
	Backoff  util.Duration `json:"backoff,omitempty" yaml:"backoff,omitempty"`   // The base delay between retries.
	Timeout  util.Duration `json:"timeout,omitempty" yaml:"timeout,omitempty"`   // The maximum time to wait for a retry.
}

func Basic

func Basic() Policy

func Long

func Long() Policy

func (Policy) MaxDelay

func (retry Policy) MaxDelay() time.Duration

func (Policy) Retrier

func (policy Policy) Retrier() Retrier

Creates a retries with the given policy

func (Policy) RetrierContext

func (policy Policy) RetrierContext(ctx context.Context) Retrier

Creates a retries with the given policy and context

func (Policy) Run

func (policy Policy) Run(f func() error) (err error)

Convenience function for running a function with a retry policy

func (Policy) RunContext

func (policy Policy) RunContext(ctx context.Context, f func() error) (err error)

Convenience function for running a function with a retry policy and context

func (Policy) Step

func (retry Policy) Step(step *int, delay *time.Duration) error

func (Policy) StepN

func (retry Policy) StepN(n int) (delay time.Duration, err error)

func (Policy) WithDefaults

func (retry Policy) WithDefaults() Policy

type Retrier

type Retrier struct {
	Context  context.Context
	Policy   Policy
	Step     int
	Delay    time.Duration
	Deadline time.Time
}

func (*Retrier) Consume

func (retry *Retrier) Consume(err error) error

func (*Retrier) ConsumeAny

func (retry *Retrier) ConsumeAny() error

Tries to consume the error, and if it can't returns the error

func (*Retrier) NextDelay

func (retry *Retrier) NextDelay() (delay time.Duration, err error)

Returns the next delay, or an error if the retries are exhausted

func (Retrier) Run

func (retry Retrier) Run(f func() error) (err error)

Runs the function until it succeeds or the retries are exhausted