rate

Documentation

Index

• type Limiter
  • func NewLimiter() *Limiter
  • func (r *Limiter) Update(key string, header http.Header)
  • func (r *Limiter) Wait(key string)

Types

type Limiter

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

Limiter holds a collection of buckets to track global and per-route rate limits. Create one with NewLimiter.

func NewLimiter

func NewLimiter() *Limiter

NewLimiter returns an initialized and ready to use Limiter.

func (*Limiter) Update

func (r *Limiter) Update(key string, header http.Header)

Update updates the rate limit for an endpoint given its key.

func (*Limiter) Wait

func (r *Limiter) Wait(key string)

Wait waits for a request to be theoretically safe to be sent (meaning it should not result in a 429 TO MANY REQUESTS) given the requested endpoint's key.