throttling

Documentation

Index

• type Limiter
  • func New(options ...Option) (*Limiter, error)
  • func (l *Limiter) Allow(ctx context.Context, cost, rate, window int64, key string) (bool, func(context.Context) error, error)
  • func (l *Limiter) AllowAfter(ctx context.Context, cost, rate, window int64, key string) (bool, time.Duration, func(context.Context) error, error)
• type Option
  • func WithInMemoryGCRA(burst int64) Option
  • func WithRedisGCRA(rc *redis.Client, burst int64) Option
  • func WithRedisSortedSet(rc *redis.Client) Option
  • func WithStatsCollector(sc statsCollector) Option

Types

type Limiter

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

func New

func New(options ...Option) (*Limiter, error)

func (*Limiter) Allow

func (l *Limiter) Allow(ctx context.Context, cost, rate, window int64, key string) (
	bool, func(context.Context) error, error,
)

Allow returns true if the limit is not exceeded, false otherwise.

func (*Limiter) AllowAfter

func (l *Limiter) AllowAfter(ctx context.Context, cost, rate, window int64, key string) (
	bool, time.Duration, func(context.Context) error, error,
)

AllowAfter returns true if the limit is not exceeded, false otherwise. Additionally, it returns the time.Duration until the next allowed request.

type Option

type Option func(*Limiter)

Option is a functional option for the limiter, see With* functions for reference

func WithInMemoryGCRA

func WithInMemoryGCRA(burst int64) Option

WithInMemoryGCRA allows to use the GCRA algorithm (in-memory) with the specified burst or with the burst as rate if the provided burst is <= 0

func WithRedisGCRA

func WithRedisGCRA(rc *redis.Client, burst int64) Option

WithRedisGCRA allows to use the GCRA algorithm (Redis version) with the specified burst or with the burst as rate if the provided burst is <= 0

func WithRedisSortedSet

func WithRedisSortedSet(rc *redis.Client) Option

WithRedisSortedSet allows to use the Redis SortedSet algorithm for rate limiting

func WithStatsCollector

func WithStatsCollector(sc statsCollector) Option

WithStatsCollector allows to setup a stats collector for the limiter