backoff

Documentation

Index

• Constants
• type Backoff
  • func New(conf Conf) *Backoff
  • func (b *Backoff) Get() time.Duration
  • func (b *Backoff) GetIncr() time.Duration
  • func (b *Backoff) GetRetries() int
  • func (b *Backoff) Incr() int
  • func (b *Backoff) Reset()
• type Conf

Constants

const (
	DefaultFactor float64 = 2.0
)

Types

type Backoff

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

Backoff calculation utility for retries.

func New

func New(conf Conf) *Backoff

func (*Backoff) Get

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

func (*Backoff) GetIncr

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

func (*Backoff) GetRetries

func (b *Backoff) GetRetries() int

func (*Backoff) Incr

func (b *Backoff) Incr() int

func (*Backoff) Reset

func (b *Backoff) Reset()

type Conf

type Conf struct {
	// Base start duration - backoff can be no shorter than the BaseStart.Add(JitterMin).
	BaseStart time.Duration
	// Base max duration - backoff can be no longer than the BaseMax.Add(JitterMax).
	BaseMax time.Duration
	// Backoff exponential growth factor.
	Factor float64
	// Min random duration to add to the backoff value to prevent potential
	// upstream overloading during the simultaneous retry among clients implementing backoff.
	// Must be less than JitterMax.
	JitterMin time.Duration
	// Max random duration to add to the backoff value to prevent potential
	// upstream overloading during the simultaneous retry among clients implementing backoff.
	// Must be greater than JitterMin.
	JitterMax time.Duration
}