throttler

Documentation

Index

• type Throttler
  • func New(refillTokens uint64, refillInterval time.Duration) *Throttler
  • func (t *Throttler) Allow() bool
  • func (t *Throttler) AllowN(n uint64) bool

Types

type Throttler

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

Throttler holds the context for a throttler instance.

func New

func New(refillTokens uint64, refillInterval time.Duration) *Throttler

New instantiates a new Throttler object - refillTokens: number of tokens to issue every refillInterval (below) - refillInterval: interval at which 'refillTokens' should be issued

func (*Throttler) Allow

func (t *Throttler) Allow() bool

Allow checks to see if a particular request should be allowed; ie, it would returns true if we are under the throttling threshold, otherwise false.

func (*Throttler) AllowN

func (t *Throttler) AllowN(n uint64) bool

AllowN checks to see if we will be allowed to do a batch of 'n' tokens; it would return true if we are under the throttling threshold, otherwise false.