ratelimit

Documentation

Index

• type Bucket
  • func (b *Bucket) Release(headers http.Header) error
• type RateLimiter
  • func NewRatelimiter() *RateLimiter
  • func (r *RateLimiter) GetBucket(key string) *Bucket
  • func (r *RateLimiter) GetWaitTime(b *Bucket, minRemaining int) time.Duration
  • func (r *RateLimiter) LockBucket(bucketID string) *Bucket
  • func (r *RateLimiter) LockBucketObject(b *Bucket) *Bucket

Types

type Bucket

type Bucket struct {
	sync.Mutex
	Key       string
	Remaining int
	// contains filtered or unexported fields
}

Bucket represents a ratelimit bucket, each bucket gets ratelimited individually (-global ratelimits).

func (*Bucket) Release

func (b *Bucket) Release(headers http.Header) error

Release unlocks the bucket and reads the headers to update the buckets ratelimit info and locks up the whole thing in case if there's a global ratelimit.

type RateLimiter

type RateLimiter struct {
	sync.Mutex
	// contains filtered or unexported fields
}

RateLimiter holds all ratelimit buckets.

func NewRatelimiter

func NewRatelimiter() *RateLimiter

NewRatelimiter returns a new RateLimiter.

func (*RateLimiter) GetBucket

func (r *RateLimiter) GetBucket(key string) *Bucket

GetBucket retrieves or creates a bucket.

func (*RateLimiter) GetWaitTime

func (r *RateLimiter) GetWaitTime(b *Bucket, minRemaining int) time.Duration

GetWaitTime returns the duration you should wait for a Bucket.

func (*RateLimiter) LockBucket

func (r *RateLimiter) LockBucket(bucketID string) *Bucket

LockBucket Locks until a request can be made.

func (*RateLimiter) LockBucketObject

func (r *RateLimiter) LockBucketObject(b *Bucket) *Bucket

LockBucketObject Locks an already resolved bucket until a request can be made.