ratelimit

Documentation

Overview

Package ratelimit provides a mechanism to rate limit requests based on a string key, refill rate and burst amount. Under the hood, it's a token bucket of size burst amount, that refills at the refill rate.

Index

• type Limiter
  • func New(r time.Duration, burst int) *Limiter
  • func (l *Limiter) Allow(key string, count int) bool
  • func (l *Limiter) Clear(key string)
  • func (l *Limiter) Wait(ctx context.Context, key string, count int) (time.Duration, error)

Types

type Limiter

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

func New

func New(r time.Duration, burst int) *Limiter

New returns a new Limiter object with refresh rate and burst amount

func (*Limiter) Allow

func (l *Limiter) Allow(key string, count int) bool

Allow checks if the limiter that belongs to 'key' has not exceeded the limit.

func (*Limiter) Clear

func (l *Limiter) Clear(key string)

Clear deletes the limiter that belongs to 'key'

func (*Limiter) Wait

func (l *Limiter) Wait(ctx context.Context, key string, count int) (time.Duration, error)

Wait blocks until the limiter permits n events to happen. Returns the time duration the limiter waited for to allow the number of events to occur.