limiter

Mar 17, 2022

Changes in this version

type Option

+ func WithClientIPHeader(header string) Option

type Options

+ ClientIPHeader string

Nov 17, 2021

Changes in this version

type Limiter

+ func (limiter *Limiter) Increment(ctx context.Context, key string, count int64) (Context, error)

type Store

+ Increment func(ctx context.Context, key string, count int64, rate Rate) (Context, error)

Jul 19, 2019

Changes in this version

type Limiter

+ func (limiter *Limiter) Reset(ctx context.Context, key string) (Context, error)

type Store

+ Reset func(ctx context.Context, key string, rate Rate) (Context, error)

Jan 17, 2019

Changes in this version

+ func GetIP(r *http.Request, options ...Options) net.IP

+ func GetIPWithMask(r *http.Request, options ...Options) net.IP

Jan 9, 2019

Changes in this version

+ const DefaultCleanUpInterval

+ const DefaultMaxRetry

+ const DefaultPrefix

+ var DefaultIPv4Mask = net.CIDRMask(32, 32)

+ var DefaultIPv6Mask = net.CIDRMask(128, 128)

+ type Context struct

+ Limit int64

+ Reached bool

+ Remaining int64

+ Reset int64

+ type Limiter struct

+ Options Options

+ Rate Rate

+ Store Store

+ func New(store Store, rate Rate, options ...Option) *Limiter

+ func (limiter *Limiter) Get(ctx context.Context, key string) (Context, error)

+ func (limiter *Limiter) GetIP(r *http.Request) net.IP

+ func (limiter *Limiter) GetIPKey(r *http.Request) string

+ func (limiter *Limiter) GetIPWithMask(r *http.Request) net.IP

+ func (limiter *Limiter) Peek(ctx context.Context, key string) (Context, error)

+ type Option func(*Options)

+ func WithIPv4Mask(mask net.IPMask) Option

+ func WithIPv6Mask(mask net.IPMask) Option

+ func WithTrustForwardHeader(enable bool) Option

+ type Options struct

+ IPv4Mask net.IPMask

+ IPv6Mask net.IPMask

+ TrustForwardHeader bool

+ type Rate struct

+ Formatted string

+ Limit int64

+ Period time.Duration

+ func NewRateFromFormatted(formatted string) (Rate, error)

+ type Store interface

+ Get func(ctx context.Context, key string, rate Rate) (Context, error)

+ Peek func(ctx context.Context, key string, rate Rate) (Context, error)

+ type StoreOptions struct

+ CleanUpInterval time.Duration

+ MaxRetry int

+ Prefix string