ratelimit

package

v2.0.0-...-e5a2643 Latest Latest Go to latest Published: Aug 14, 2021 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/WelcomerTeam/RealRock

Documentation ¶

Index ¶

type Bucket
- func (b *Bucket) Release(headers http.Header) error
type RateLimiter
- func NewRatelimiter() *RateLimiter

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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.

Source Files ¶

View all Source files

ratelimit.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL