backoff

Documentation

Index

• Constants
• type Backoff
  • func Default() *Backoff
  • func New(factor float64, jitter bool, max, min time.Duration) *Backoff
  • func WithoutJitter() *Backoff
  • func (b *Backoff) Attempts() uint64
  • func (b *Backoff) Next() time.Duration
  • func (b *Backoff) Reset()

Constants

const (
	// DefaultFactor factor
	DefaultFactor = math.E
	// DefaultJitter jitter
	DefaultJitter = true
	// DefaultMaxInterval max interval
	DefaultMaxInterval = 3 * time.Minute
	// DefaultMinInterval min interval
	DefaultMinInterval = 100 * time.Millisecond
	// MaxInt64 the max int64 to avoid overflow
	MaxInt64 = float64(math.MaxInt64 - 1024)
)

Types

type Backoff

type Backoff struct {
	Factor float64
	Jitter bool
	Max    time.Duration
	Min    time.Duration
	// contains filtered or unexported fields
}

Backoff struct

func Default

func Default() *Backoff

Default return backoff instance with default value

func New

func New(factor float64, jitter bool, max, min time.Duration) *Backoff

New create backoff instance

func WithoutJitter

func WithoutJitter() *Backoff

WithoutJitter return backoff instance with default value except jitter

func (*Backoff) Attempts

func (b *Backoff) Attempts() uint64

Attempts return the attempt times

func (*Backoff) Next

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

Next return next interval time to backoff

func (*Backoff) Reset

func (b *Backoff) Reset()

Reset use for reset backoff attempt times