ratelimit

README

ratelimit

限流算法

Documentation

Index

• type Limiter
  • func NewFixedWindowLimiter(limit int, window time.Duration) Limiter
  • func NewLeakyBucketLimiter(peakLevel, currentVelocity int) Limiter
  • func NewSlidingLogLimiter(smallWindow time.Duration, strategies ...*SlidingLogLimiterStrategy) (Limiter, error)
  • func NewSlidingWindowLimiter(limit int, window, smallWindow time.Duration) (Limiter, error)
  • func NewTokenBucketLimiter(capacity, rate int) Limiter
• type RedisLimiter
• type SlidingLogLimiterStrategy
  • func NewSlidingLogLimiterStrategy(limit int, window time.Duration) *SlidingLogLimiterStrategy
• type ViolationStrategyError
  • func (e *ViolationStrategyError) Error() string

Types

type Limiter

type Limiter interface {
	TryAcquire() error
}

func NewFixedWindowLimiter

func NewFixedWindowLimiter(limit int, window time.Duration) Limiter

func NewLeakyBucketLimiter

func NewLeakyBucketLimiter(peakLevel, currentVelocity int) Limiter

func NewSlidingLogLimiter

func NewSlidingLogLimiter(smallWindow time.Duration, strategies ...*SlidingLogLimiterStrategy) (Limiter, error)

func NewSlidingWindowLimiter

func NewSlidingWindowLimiter(limit int, window, smallWindow time.Duration) (Limiter, error)

func NewTokenBucketLimiter

func NewTokenBucketLimiter(capacity, rate int) Limiter

type RedisLimiter

type RedisLimiter interface {
	TryAcquire(ctx context.Context, source string) error
}

type SlidingLogLimiterStrategy

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

SlidingLogLimiterStrategy 滑动日志限流器的策略

func NewSlidingLogLimiterStrategy

func NewSlidingLogLimiterStrategy(limit int, window time.Duration) *SlidingLogLimiterStrategy

type ViolationStrategyError

type ViolationStrategyError struct {
	Limit  int           // 窗口请求上限
	Window time.Duration // 窗口时间大小
}

ViolationStrategyError 违背策略错误

func (*ViolationStrategyError) Error

func (e *ViolationStrategyError) Error() string