rate

Documentation

Index

• Constants
• Variables
• func NewLimiter(r float64, b int) limiter.Limiter
• func NewRateLimiter(opts ...Option) limiter.RateLimiter
• type Option
  • func FileLoaderOption(fileLoader loader.Loader) Option
  • func HTTPLoaderOption(httpLoader loader.Loader) Option
  • func LimitsOption(limits ...string) Option
  • func LoggerOption(logger logger.Logger) Option
  • func RedisLoaderOption(redisLoader loader.Loader) Option
  • func ReloadPeriodOption(period time.Duration) Option
• type RateLimitGenerator
  • func NewRateLimitGenerator(r float64) RateLimitGenerator
  • func NewRateLimitSingleGenerator(r float64) RateLimitGenerator

Constants

const (
	GlobalLimitKey = "$"
	IPLimitKey     = "$$"
)

Variables

var (
	ErrRateLimit = errors.New("rate limit")
)

Functions

func NewLimiter

func NewLimiter(r float64, b int) limiter.Limiter

func NewRateLimiter

func NewRateLimiter(opts ...Option) limiter.RateLimiter

Types

type Option

type Option func(opts *options)

func FileLoaderOption

func FileLoaderOption(fileLoader loader.Loader) Option

func HTTPLoaderOption

func HTTPLoaderOption(httpLoader loader.Loader) Option

func LimitsOption

func LimitsOption(limits ...string) Option

func LoggerOption

func LoggerOption(logger logger.Logger) Option

func RedisLoaderOption

func RedisLoaderOption(redisLoader loader.Loader) Option

func ReloadPeriodOption

func ReloadPeriodOption(period time.Duration) Option

type RateLimitGenerator

type RateLimitGenerator interface {
	Limiter() limiter.Limiter
}

func NewRateLimitGenerator

func NewRateLimitGenerator(r float64) RateLimitGenerator

func NewRateLimitSingleGenerator

func NewRateLimitSingleGenerator(r float64) RateLimitGenerator