slidingwindow

Documentation

Index

• type DefaultLimiter
  • func (l *DefaultLimiter) ShouldAllow(ctx context.Context, key string, size time.Duration, limit int64) (allow bool, err error)
• type RateLimiter
  • func NewDefaultLimiter(redisClient redis.Cmdable) RateLimiter

Types

type DefaultLimiter

type DefaultLimiter struct {
	RedisClient redis.Cmdable
}

DefaultLimiter implements Sliding-Windows-Log rate limiter algorithm

func (*DefaultLimiter) ShouldAllow

func (l *DefaultLimiter) ShouldAllow(ctx context.Context, key string, size time.Duration, limit int64) (allow bool, err error)

ShouldAllow returns if current request is allowed or not.

type RateLimiter

type RateLimiter interface {
	ShouldAllow(ctx context.Context, key string, size time.Duration, limit int64) (allow bool, err error)
}

func NewDefaultLimiter

func NewDefaultLimiter(redisClient redis.Cmdable) RateLimiter