throttled

Mar 25, 2023

Changes in this version

+ type GCRARateLimiterCtx struct

+ func NewGCRARateLimiterCtx(st GCRAStoreCtx, quota RateQuota) (*GCRARateLimiterCtx, error)

+ func (g *GCRARateLimiterCtx) RateLimit(key string, quantity int) (bool, RateLimitResult, error)

+ func (g *GCRARateLimiterCtx) RateLimitCtx(ctx context.Context, key string, quantity int) (bool, RateLimitResult, error)

+ func (g *GCRARateLimiterCtx) SetMaxCASAttemptsLimit(limit int)

+ type GCRAStoreCtx interface

+ CompareAndSwapWithTTL func(ctx context.Context, key string, old, new int64, ttl time.Duration) (bool, error)

+ GetWithTime func(ctx context.Context, key string) (int64, time.Time, error)

+ SetIfNotExistsWithTTL func(ctx context.Context, key string, value int64, ttl time.Duration) (bool, error)

+ func WrapStoreWithContext(store GCRAStore) GCRAStoreCtx

+ type HTTPRateLimiterCtx struct

+ DeniedHandler http.Handler

+ Error func(w http.ResponseWriter, r *http.Request, err error)

+ RateLimiter RateLimiterCtx

+ VaryBy interface{ ... }

+ func (t *HTTPRateLimiterCtx) RateLimit(h http.Handler) http.Handler

+ type RateLimiterCtx interface

+ RateLimitCtx func(ctx context.Context, key string, quantity int) (bool, RateLimitResult, error)

+ func WrapRateLimiterWithContext(rateLimier RateLimiter) RateLimiterCtx

Jul 17, 2021

Changes in this version

type GCRARateLimiter

+ func (g *GCRARateLimiter) SetMaxCASAttemptsLimit(limit int)

Aug 4, 2020

Changes in this version

type Rate

+ func PerDuration(n int, d time.Duration) Rate

Aug 2, 2020

Changes in this version

+ var DefaultDeniedHandler = http.Handler(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { ... }))

+ var DefaultError = func(w http.ResponseWriter, r *http.Request, err error)

+ type GCRARateLimiter struct

+ func NewGCRARateLimiter(st GCRAStore, quota RateQuota) (*GCRARateLimiter, error)

+ func (g *GCRARateLimiter) RateLimit(key string, quantity int) (bool, RateLimitResult, error)

+ type GCRAStore interface

+ CompareAndSwapWithTTL func(key string, old, new int64, ttl time.Duration) (bool, error)

+ GetWithTime func(key string) (int64, time.Time, error)

+ SetIfNotExistsWithTTL func(key string, value int64, ttl time.Duration) (bool, error)

+ type HTTPRateLimiter struct

+ DeniedHandler http.Handler

+ Error func(w http.ResponseWriter, r *http.Request, err error)

+ RateLimiter RateLimiter

+ VaryBy interface{ ... }

+ func (t *HTTPRateLimiter) RateLimit(h http.Handler) http.Handler

+ type Q struct

+ Requests int

+ Window time.Duration

+ func (q Q) Quota() (int, time.Duration)

+ type Quota interface

+ Quota func() (int, time.Duration)

+ type Rate struct

+ func PerDay(n int) Rate

+ func PerHour(n int) Rate

+ func PerMin(n int) Rate

+ func PerSec(n int) Rate

+ func (q Rate) Quota() (int, time.Duration)

+ type RateLimitResult struct

+ Limit int

+ Remaining int

+ ResetAfter time.Duration

+ RetryAfter time.Duration

+ type RateLimiter interface

+ RateLimit func(key string, quantity int) (bool, RateLimitResult, error)

+ type RateQuota struct

+ MaxBurst int

+ MaxRate Rate

+ type Store interface

+ type Throttler struct

+ func RateLimit(q Quota, vary *VaryBy, store GCRAStore) *Throttler

+ func (t *Throttler) Throttle(h http.Handler) http.Handler

+ type VaryBy struct

+ Cookies []string

+ Custom func(r *http.Request) string

+ Headers []string

+ Method bool

+ Params []string

+ Path bool

+ RemoteAddr bool

+ Separator string

+ func (vb *VaryBy) Key(r *http.Request) string