backoff

Documentation

Index

• type ExponentialBackoff
  • func (e *ExponentialBackoff) Maxed() bool
  • func (e *ExponentialBackoff) Wait(ctx context.Context) (err error)

Types

type ExponentialBackoff

type ExponentialBackoff struct {
	Delay time.Duration `help:"The active time between retries, typically not set" default:"0ms"`
	Max   time.Duration `help:"The maximum total time to allow retries" default:"5m"`
	Min   time.Duration `help:"The minimum time between retries" default:"100ms"`
}

ExponentialBackoff provides delays between failing attempts.

func (*ExponentialBackoff) Maxed

func (e *ExponentialBackoff) Maxed() bool

Maxed returns true if the wait time has maxed out.

func (*ExponentialBackoff) Wait

func (e *ExponentialBackoff) Wait(ctx context.Context) (err error)

Wait should be called when there is a failure. Each time it is called it will sleep an exponentially longer time, up to a max.