ratelimit

package module

v0.0.1-rc.1 Latest Latest Go to latest Published: Jul 6, 2023 License: MIT Imports: 3 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

A bunch of rate limiting libraries.

This section is empty.

View Source

var SlidingWindowScript = `` /* 854-byte string literal not displayed */

View Source

var TokenBucketScript = `` /* 1740-byte string literal not displayed */

func MillisToTime(m int64) time.Time

func TimeMillis(t time.Time) int64

type Bucket struct {
	Identifier string
	Rate       int
	WindowSize int
	Store      Store
}

func NewTokenBucket(identifier string, rate, windowSize int, store Store) Bucket

NewTokenBucket returns a new rate limiter which uses the token bucket algorithm.

func (b *Bucket) Allow(key string) (bool, error)

func (b *Bucket) AllowWithStatus(key string) (Status, error)

type RedigoStore struct {
	Pool   *redis.Pool
	Script *redis.Script
}

func NewRedigoSWStore(pool *redis.Pool) RedigoStore

func NewRedigoStore(pool *redis.Pool) RedigoStore

func (s *RedigoStore) Inc(key string, rate, windowSize, now int) (StoreResponse, error)

type SlidingWindow struct {
	Identifier string
	Rate       int
	WindowSize int
	Store      Store
}

func NewSlidingWindow(identifier string, rate, windowSize int, store Store) SlidingWindow

NewSlidingWindow returns a new rate limiter which uses the token bucket algorithm.

func (sw *SlidingWindow) Allow(key string) (bool, error)

func (sw *SlidingWindow) AllowWithStatus(key string) (Status, error)

type Status struct {
	Allowed     bool
	Remaining   int
	NextRefresh time.Duration
}

type Store interface {
	Inc(key string, rate, windowSize, now int) (StoreResponse, error)
}

type StoreResponse struct {
	Allowed    bool
	Counter    int
	LastRefill time.Time
}