backoff

Documentation

Index

• type Backoff
  • func NewBackoff(initialBackoffDuration time.Duration, maxBackoffDuration time.Duration, ...) *Backoff
  • func (b *Backoff) Backoff(key string, currentTime time.Time) time.Time
  • func (b *Backoff) IsBackedOff(key string, currentTime time.Time) bool
  • func (b *Backoff) RemoveBackoff(key string)
  • func (b *Backoff) RemoveStaleBackoffData(currentTime time.Time)

Types

type Backoff

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

Backoff handles backing off executions.

func NewBackoff

func NewBackoff(initialBackoffDuration time.Duration, maxBackoffDuration time.Duration, backoffResetTimeout time.Duration) *Backoff

NewBackoff creates an instance of Backoff.

func (*Backoff) Backoff

func (b *Backoff) Backoff(key string, currentTime time.Time) time.Time

Backoff execution for the given key. Returns time till execution is backed off.

func (*Backoff) IsBackedOff

func (b *Backoff) IsBackedOff(key string, currentTime time.Time) bool

IsBackedOff returns true if execution is backed off for the given key.

func (*Backoff) RemoveBackoff

func (b *Backoff) RemoveBackoff(key string)

RemoveBackoff removes backoff data for the given key.

func (*Backoff) RemoveStaleBackoffData

func (b *Backoff) RemoveStaleBackoffData(currentTime time.Time)

RemoveStaleBackoffData removes stale backoff data.