rate

Documentation

Index

• type Limiter
  • func (limiter Limiter) Count(key string) (int64, error)
  • func (limiter Limiter) Hit(key string) (int64, error)
• type RedisClient

Types

type Limiter

type Limiter struct {
	RedisClient RedisClient
	Decay       time.Duration
	Limit       int
}

Limiter helper for making sure we don't call something too much

func (Limiter) Count

func (limiter Limiter) Count(key string) (int64, error)

Count returns number of attempts done till now

func (Limiter) Hit

func (limiter Limiter) Hit(key string) (int64, error)

Hit adds a hit to redis and finally returns a new Count

type RedisClient

type RedisClient interface {
	ZAdd(key string, members ...redis.Z) (int64, error)
	ZRemRangeByScore(key, min, max string) (int64, error)
	Expire(key string, expiration time.Duration) (bool, error)
	ZCard(key string) (int64, error)
}

RedisClient interface need to satisfy for Limiter to work