ratelimiter

type Config struct {
	// 不需要限流的接口
	Exclude []string `json:"exclude"`
	// 根据Exclude产生的Path.PathSkipper
	Skipper handler.Skipper
	// RedisOptions store为redis时的配置
	RedisOptions *RedisOptions `json:"redisOptions"`
	// InMemoryOptions store为memory时的配置
	InMemoryOptions *InMemoryOptions `json:"inMemoryOptions"`
	// StoreKey the key of cache manager.
	StoreKey string `json:"storeKey"`
	// KeyFunc
	KeyFunc string `json:"keyFunc"`
	// IncludeKeys 这些 key 应用限流（如果设置，其他 key 不限流）
	IncludeKeys []string `json:"includeKeys"`
	// ExcludeKeys 这些 key 不限流（优先级高于 includeKeys）
	ExcludeKeys []string `json:"excludeKeys"`
	// contains filtered or unexported fields
}

type InMemoryOptions struct {
	// Rate 限流窗口时长
	Rate time.Duration
	// Limit 窗口内允许的最大请求数
	Limit uint
	// Skip 跳过限流的条件判断函数
	Skip func(*gin.Context) bool
}

type Info struct {
	// Limit 限流窗口内允许的最大请求数
	Limit uint
	// RateLimited 是否被限流
	RateLimited bool
	// ResetTime 限流窗口重置时间
	ResetTime time.Time
	// RemainingHits 剩余可用请求数
	RemainingHits uint
}

type Options struct {
	// KeyFunc 从请求中提取限流 key 的函数
	KeyFunc func(*gin.Context) string
	// ErrorHandler 被限流时的响应处理函数
	ErrorHandler func(*gin.Context, Info)
	// BeforeResponse 每次请求的响应前处理函数（设置 header 等）
	BeforeResponse func(*gin.Context, Info)
}

type RedisOptions struct {
	// RedisClient Redis 客户端实例
	RedisClient *redis.Client
	// Rate 限流窗口时长
	Rate time.Duration
	// Limit 窗口内允许的最大请求数
	Limit uint
	// Skip 跳过限流的条件判断函数
	Skip func(*gin.Context) bool
}

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

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

type Store interface {
	Limit(key string, c *gin.Context) Info
}