backoff

Documentation

Index

• type Backoff
  • func New(o Options) (*Backoff, error)
  • func (b *Backoff) Next() (time.Duration, bool)
  • func (b *Backoff) Reset()
  • func (b *Backoff) Retry(ctx context.Context, err error) error
• type Options
  • func (o *Options) FillDefaults()
  • func (o *Options) Validate() error

Types

type Backoff

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

func New

func New(o Options) (*Backoff, error)

func (*Backoff) Next

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

func (*Backoff) Reset

func (b *Backoff) Reset()

func (*Backoff) Retry

func (b *Backoff) Retry(ctx context.Context, err error) error

type Options

type Options struct {
	// Must be positive. Zero means default.
	Min time.Duration
	// Must be positive. Zero means default.
	Max time.Duration
	// Must be >= 1.0. Zero means default.
	Grow float64
	// Must be >= 1.0. Zero means default.
	Jitter float64
	// Zero means default, negative means unlimited.
	MaxAttempts int64
}

func (*Options) FillDefaults

func (o *Options) FillDefaults()

func (*Options) Validate

func (o *Options) Validate() error