backoff

Documentation

Index

• type Backoff
  • func Constant(delay time.Duration) Backoff
  • func Exponential(initial, max time.Duration) (Backoff, error)
  • func ExponentialWithGrowthRate(initial, max time.Duration, growth float64) (Backoff, error)
  • func Zero() Backoff

Types

type Backoff

type Backoff interface {
	// Next returns the next amount of backoff to wait before retrying
	// based on the amount of retries already attempted.
	Next(retries int) time.Duration
}

Backoff allows us to customise the amount of delay (or backoff) between HTTP request retries.

func Constant

func Constant(delay time.Duration) Backoff

Constant returns a backoff strategy which always waits the same amount of time between requests.

func Exponential

func Exponential(initial, max time.Duration) (Backoff, error)

Exponential applies an exponential type strategy from the initial interval up to the defined max using the default growth rate.

func ExponentialWithGrowthRate

func ExponentialWithGrowthRate(initial, max time.Duration, growth float64) (Backoff, error)

ExponentialWithGrowthRate applies an exponential type strategy from the initial interval up to the defined max using the supplied growth rate which should be between 0.1 and 1.0 (1% - 100% growth)

func Zero

func Zero() Backoff

Zero returns a backoff strategy which always allows no time for delay between attempts.