ratelimit

Documentation

Index

• type Builder
  • func NewBuilder() *Builder
  • func (b *Builder) Build() gin.HandlerFunc
  • func (b *Builder) Prefix(prefix string) *Builder
• type Limiter
  • func NewRedisSlideWindowLimiter(cmd redis.Cmdable, interval time.Duration, rate int) Limiter
• type RedisSlideWindowLimiter
  • func (r *RedisSlideWindowLimiter) Limit(ctx context.Context, key string) (bool, error)

Types

type Builder

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

func NewBuilder

func NewBuilder() *Builder

func (*Builder) Build

func (b *Builder) Build() gin.HandlerFunc

func (*Builder) Prefix

func (b *Builder) Prefix(prefix string) *Builder

type Limiter

type Limiter interface {

	/*Limit 就是有没有触发限流, key 就是限流对象
	  如果是对ip限流,那 key 就是ip地址
	  bool 代表是否限流, true 就是要限流
	  error 代表限流器本身是否有错误 */
	Limit(ctx context.Context, key string) (bool, error)
}

func NewRedisSlideWindowLimiter

func NewRedisSlideWindowLimiter(cmd redis.Cmdable,
	interval time.Duration, rate int) Limiter

type RedisSlideWindowLimiter

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

func (*RedisSlideWindowLimiter) Limit

func (r *RedisSlideWindowLimiter) Limit(ctx context.Context, key string) (bool, error)