ratelimit

README

Rate Limit

A bunch of rate limiting libraries.

• Token Bucket
• Sliding Window
• Sliding Window with Approximation

API

Documentation

Index

• func MillisToTime(m int64) time.Time
• func TimeMillis(t time.Time) int64
• type Bucket
  • func NewTokenBucket(identifier string, rate, windowSize int, store Store) Bucket
  • func (b *Bucket) Allow(key string) (bool, error)
  • func (b *Bucket) AllowWithStatus(key string) (Status, error)
• type RedigoStore
  • 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
  • func NewSlidingWindow(identifier string, rate, windowSize int, store Store) SlidingWindow
  • func (sw *SlidingWindow) Allow(key string) (bool, error)
  • func (sw *SlidingWindow) AllowWithStatus(key string) (Status, error)
• type Status
• type Store
• type StoreResponse

Functions

func MillisToTime

func MillisToTime(m int64) time.Time

func TimeMillis

func TimeMillis(t time.Time) int64

Types

type Bucket

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

func NewTokenBucket

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

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

func (*Bucket) Allow

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

func (*Bucket) AllowWithStatus

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

type RedigoStore

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

func NewRedigoSWStore

func NewRedigoSWStore(pool *redis.Pool) RedigoStore

func NewRedigoStore

func NewRedigoStore(pool *redis.Pool) RedigoStore

func (*RedigoStore) Inc

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

type SlidingWindow

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

func NewSlidingWindow

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

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

func (*SlidingWindow) Allow

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

func (*SlidingWindow) AllowWithStatus

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

type Status

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

type Store

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

type StoreResponse

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