slowdown

Documentation

Index

• func Do[T any](s *SlowDown, ctx context.Context, fn func() (T, error)) (t T, err error)
• type Backoff
  • func (b *Backoff) Attempt() float64
  • func (b *Backoff) Copy() *Backoff
  • func (b *Backoff) Duration() time.Duration
  • func (b *Backoff) ForAttempt(attempt float64) time.Duration
  • func (b *Backoff) Reset()
• type SlowDown
  • func New() *SlowDown
  • func (s *SlowDown) Wait(ctx context.Context) (err error)

Functions

func Do

func Do[T any](s *SlowDown, ctx context.Context, fn func() (T, error)) (t T, err error)

Types

type Backoff

type Backoff struct {

	// Factor is the multiplying factor for each increment step
	Factor float64
	// Jitter eases contention by randomizing backoff steps
	Jitter bool
	// Min and Max are the minimum and maximum values of the counter
	Min, Max time.Duration
	// contains filtered or unexported fields
}

Backoff is a time.Duration counter, starting at Min. After every call to the Duration method the current timing is multiplied by Factor, but it never exceeds Max.

Backoff is not generally concurrent-safe, but the ForAttempt method can be used concurrently.

func (*Backoff) Attempt

func (b *Backoff) Attempt() float64

Attempt returns the current attempt counter value.

func (*Backoff) Copy

func (b *Backoff) Copy() *Backoff

Copy returns a backoff with equals constraints as the original

func (*Backoff) Duration

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

Duration returns the duration for the current attempt before incrementing the attempt counter. See ForAttempt.

func (*Backoff) ForAttempt

func (b *Backoff) ForAttempt(attempt float64) time.Duration

ForAttempt returns the duration for a specific attempt. This is useful if you have a large number of independent Backoffs, but don't want use unnecessary memory storing the Backoff parameters per Backoff. The first attempt should be 0.

ForAttempt is concurrent-safe.

func (*Backoff) Reset

func (b *Backoff) Reset()

Reset restarts the current attempt counter at zero.

type SlowDown

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

func New

func New() *SlowDown

func (*SlowDown) Wait

func (s *SlowDown) Wait(ctx context.Context) (err error)