backoff

Documentation

Index

• type Backoff
  • func (b *Backoff) Attempts() int
  • func (b *Backoff) Duration() (dur time.Duration)
  • func (b *Backoff) Reset()

Types

type Backoff

type Backoff struct {

	// Initial value to scale out
	Initial time.Duration
	// Jitter value randomizes an additional delay between 0 and Jitter
	Jitter time.Duration
	// Max maximum values of the backoff
	Max time.Duration
	// contains filtered or unexported fields
}

Backoff is a time.Duration counter. It starts at Min. After every call to Duration() it is multiplied by Factor. It is capped at Max. It returns to Min on every call to Reset(). Used in conjunction with the time package.

func (*Backoff) Attempts

func (b *Backoff) Attempts() int

Attempts returns the number of attempts that we had done so far

func (*Backoff) Duration

func (b *Backoff) Duration() (dur time.Duration)

Returns the current value of the counter and then multiplies it Factor

func (*Backoff) Reset

func (b *Backoff) Reset()

Resets the current value of the counter back to Min