redis_rate

README

Redis Rate Limiter

This package was heavily inspired from github.com/go-redis/redis_rate. It was re-written to support github.com/gomodule/redigo

Documentation

Index

• type Limit
  • func PerHour(rate int) Limit
  • func PerMinute(rate int) Limit
  • func PerSecond(rate int) Limit
  • func (l Limit) IsZero() bool
  • func (l Limit) String() string
• type Limiter
  • func NewLimiter(conn redis.Conn) *Limiter
  • func (l Limiter) Allow(key string, limit Limit) (*Result, error)
  • func (l Limiter) AllowAtMost(key string, limit Limit, n int) (*Result, error)
  • func (l Limiter) AllowN(key string, limit Limit, n int) (*Result, error)
  • func (l *Limiter) Reset(key string) error
• type Result

Types

type Limit

type Limit struct {
	Rate   int
	Burst  int
	Period time.Duration
}

func PerHour

func PerHour(rate int) Limit

func PerMinute

func PerMinute(rate int) Limit

func PerSecond

func PerSecond(rate int) Limit

func (Limit) IsZero

func (l Limit) IsZero() bool

func (Limit) String

func (l Limit) String() string

type Limiter

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

Limiter controls how frequently events are allowed to happen.

func NewLimiter

func NewLimiter(conn redis.Conn) *Limiter

NewLimiter returns a new Limiter.

func (Limiter) Allow

func (l Limiter) Allow(key string, limit Limit) (*Result, error)

Allow is a shortcut for AllowN(ctx, key, limit, 1).

func (Limiter) AllowAtMost

func (l Limiter) AllowAtMost(
	key string,
	limit Limit,
	n int,
) (*Result, error)

AllowAtMost reports whether at most n events may happen at time now. It returns number of allowed events that is less than or equal to n.

func (Limiter) AllowN

func (l Limiter) AllowN(
	key string,
	limit Limit,
	n int,
) (*Result, error)

AllowN reports whether n events may happen at time now.

func (*Limiter) Reset

func (l *Limiter) Reset(key string) error

Reset gets a key and reset all limitations and previous usages

type Result

type Result struct {
	// Limit is the limit that was used to obtain this result.
	Limit Limit

	// Allowed is the number of events that may happen at time now.
	Allowed int

	// Remaining is the maximum number of requests that could be
	// permitted instantaneously for this key given the current
	// state. For example, if a rate limiter allows 10 requests per
	// second and has already received 6 requests for this key this
	// second, Remaining would be 4.
	Remaining int

	// RetryAfter is the time until the next request will be permitted.
	// It should be -1 unless the rate limit has been exceeded.
	RetryAfter time.Duration

	// ResetAfter is the time until the RateLimiter returns to its
	// initial state for a given key. For example, if a rate limiter
	// manages requests per second and received one request 200ms ago,
	// Reset would return 800ms. You can also think of this as the time
	// until Limit and Remaining will be equal.
	ResetAfter time.Duration
}