ratelimit

Documentation

Index

• Variables
• func AnonLimitKey(methodName, peer string) string
• func AuthLimitKey(methodName, authID string) string
• type Limiter
• type Noop
  • func NewNoop() *Noop
  • func (n Noop) Limit(ctx context.Context, limitKey string, limit redis_rate.Limit) error
  • func (n Noop) Ping(ctx context.Context) error
• type QuotaExceededError
  • func NewQuotaExceededError(message string) QuotaExceededError
  • func (e QuotaExceededError) Error() string
• type Redis
  • func NewRedis(client *redis.Client) *Redis
  • func (l *Redis) Limit(ctx context.Context, limitKey string, limit redis_rate.Limit) error
  • func (l *Redis) Ping(ctx context.Context) error

Variables

var Default = redis_rate.PerMinute(180)

var Public = redis_rate.PerMinute(750)

var Sensitive = redis_rate.PerMinute(30)

var Unlimited = redis_rate.PerSecond(math.MaxInt)

var Zero = redis_rate.Limit{}

Functions

func AnonLimitKey

func AnonLimitKey(methodName, peer string) string

func AuthLimitKey

func AuthLimitKey(methodName, authID string) string

Types

type Limiter

type Limiter interface {
	Limit(ctx context.Context, limitKey string, limit redis_rate.Limit) error
	Ping(ctx context.Context) error
}

Limiter returns an error if quota per key is exceeded.

type Noop

type Noop struct{}

Noop performs no rate limiting. This can be useful in local/testing environments or when rate limiting is not required.

func NewNoop

func NewNoop() *Noop

func (Noop) Limit

func (n Noop) Limit(ctx context.Context, limitKey string, limit redis_rate.Limit) error

func (Noop) Ping

func (n Noop) Ping(ctx context.Context) error

type QuotaExceededError

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

func NewQuotaExceededError

func NewQuotaExceededError(message string) QuotaExceededError

func (QuotaExceededError) Error

func (e QuotaExceededError) Error() string

type Redis

type Redis struct {
	*redis_rate.Limiter
	// contains filtered or unexported fields
}

Redis offers rate limiting functionality using a Redis-based rate limiter.

func NewRedis

func NewRedis(client *redis.Client) *Redis

func (*Redis) Limit

func (l *Redis) Limit(ctx context.Context, limitKey string, limit redis_rate.Limit) error

func (*Redis) Ping

func (l *Redis) Ping(ctx context.Context) error