flowcontrol

Documentation

Index

• type Backoff
  • func NewBackOff(initial, max time.Duration) *Backoff
  • func NewFakeBackOff(initial, max time.Duration, tc *util.FakeClock) *Backoff
  • func (p *Backoff) DeleteEntry(id string)
  • func (p *Backoff) GC()
  • func (p *Backoff) Get(id string) time.Duration
  • func (p *Backoff) IsInBackOffSince(id string, eventTime time.Time) bool
  • func (p *Backoff) IsInBackOffSinceUpdate(id string, eventTime time.Time) bool
  • func (p *Backoff) Next(id string, eventTime time.Time)
  • func (p *Backoff) Reset(id string)

Types

type Backoff

type Backoff struct {
	sync.Mutex
	Clock util.Clock
	// contains filtered or unexported fields
}

func NewBackOff

func NewBackOff(initial, max time.Duration) *Backoff

func NewFakeBackOff

func NewFakeBackOff(initial, max time.Duration, tc *util.FakeClock) *Backoff

func (*Backoff) DeleteEntry

func (p *Backoff) DeleteEntry(id string)

func (*Backoff) GC

func (p *Backoff) GC()

Garbage collect records that have aged past maxDuration. Backoff users are expected to invoke this periodically.

func (*Backoff) Get

func (p *Backoff) Get(id string) time.Duration

Get the current backoff Duration

func (*Backoff) IsInBackOffSince

func (p *Backoff) IsInBackOffSince(id string, eventTime time.Time) bool

Returns True if the elapsed time since eventTime is smaller than the current backoff window

func (*Backoff) IsInBackOffSinceUpdate

func (p *Backoff) IsInBackOffSinceUpdate(id string, eventTime time.Time) bool

Returns True if time since lastupdate is less than the current backoff window.

func (*Backoff) Next

func (p *Backoff) Next(id string, eventTime time.Time)

move backoff to the next mark, capping at maxDuration

func (*Backoff) Reset

func (p *Backoff) Reset(id string)

Reset forces clearing of all backoff data for a given key.