rate

type Bucket ¶

type Bucket struct {
	RefillDate      time.Time
	AvailableTokens int
}

Bucket holds data about the state of a bucket

func (b *Bucket) Pick(now time.Time, limit BucketLimit) bool

type BucketLimit ¶

type BucketLimit struct {
	Delay time.Duration
	Count int
}

BucketLimit defines how a bucket is filled

type Key ¶

type Key func(c router.Context) interface{}

Key is a way to extract an identifier from a request

type RateLimiter ¶

type RateLimiter struct {
	Limits []BucketLimit

	Key Key
	// contains filtered or unexported fields
}

RateLimiter allows rate limiting requests by IP

The basic algorithm is a bucket filled with tokens: - every `Delay` `Count` tokens are added into the bucket - every time a request is made it takes a token from the bucket

func New(key Key, size int, limits ...BucketLimit) (*RateLimiter, error)

func (l *RateLimiter) Middleware(next router.Route) router.Route

func (l *RateLimiter) Pick(now time.Time, key interface{}) bool