rate_limiter

Documentation

Index

• Constants
• Variables
• type DefaultRateLimiter
  • func NewDefaultRateLimiter(redisClient *redis.Client, limit int, period time.Duration) (*DefaultRateLimiter, error)
  • func (d *DefaultRateLimiter) GetKey(ip string) string
  • func (d *DefaultRateLimiter) Limit(ip string) error
  • func (d *DefaultRateLimiter) SetInitialValue(key string) error
• type RateLimiter

Constants

const (
	// RateLimiterPrefix is the prefix of the rate limiter key
	RateLimiterPrefix = "rate_limiter"
)

Variables

var (
	TooManyRequestsError = errors.New("too many requests")
	NilRateLimiterError  = errors.New("nil rate limiter")
)

Types

type DefaultRateLimiter

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

DefaultRateLimiter struct

func NewDefaultRateLimiter

func NewDefaultRateLimiter(redisClient *redis.Client, limit int, period time.Duration) (*DefaultRateLimiter, error)

NewDefaultRateLimiter creates a new rate limiter

func (*DefaultRateLimiter) GetKey

func (d *DefaultRateLimiter) GetKey(ip string) string

GetKey gets the rate limiter key

func (*DefaultRateLimiter) Limit

func (d *DefaultRateLimiter) Limit(ip string) error

Limit limits the rate of requests

func (*DefaultRateLimiter) SetInitialValue

func (d *DefaultRateLimiter) SetInitialValue(key string) error

SetInitialValue sets the initial value for the given key

type RateLimiter

type RateLimiter interface {
	Limit(ip string) error
}

RateLimiter interface