Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

limiters

package module

Go to main page

Versions in this module

v0

v0.0.6

Feb 4, 2022

Changes in this version

type TokenBucketOpts

+ Capacity int64

+ Clock Clock

+ Locker DistLocker

+ Logger Logger

+ RefillRate time.Duration

+ RefillTokens int64

+ TokenBucketStateBackend TokenBucketStateBackend

v0.0.5

Feb 4, 2022

Changes in this version

+ var ErrLimitExhausted = errors.New("requests limit exhausted")

+ var ErrRaceCondition = errors.New("race condition detected")

+ type Clock interface

+ Now func() time.Time

+ type ConcurrentBuffer struct

+ func NewConcurrentBuffer(locker DistLocker, concurrentStateBackend ConcurrentBufferBackend, ...) *ConcurrentBuffer

+ func (c *ConcurrentBuffer) Done(key string) error

+ func (c *ConcurrentBuffer) Limit(ctx context.Context, key string) error

+ type ConcurrentBufferBackend interface

+ Add func(ctx context.Context, key string) (int64, error)

+ Remove func(key string) error

+ type ConcurrentBufferInMemory struct

+ func NewConcurrentBufferInMemory(registry *Registry, ttl time.Duration, clock Clock) *ConcurrentBufferInMemory

+ func (c *ConcurrentBufferInMemory) Add(ctx context.Context, key string) (int64, error)

+ func (c *ConcurrentBufferInMemory) Remove(key string) error

+ type ConcurrentBufferRedis struct

+ func NewConcurrentBufferRedis(cli *redis.Client, key string, ttl time.Duration, clock Clock) *ConcurrentBufferRedis

+ func (c *ConcurrentBufferRedis) Add(ctx context.Context, key string) (int64, error)

+ func (c *ConcurrentBufferRedis) Remove(key string) error

+ type DistLocker interface

+ Lock func(ctx context.Context) error

+ Unlock func() error

+ type FixedWindow struct

+ func NewFixedWindow(capacity int64, rate time.Duration, ...) *FixedWindow

+ func (f *FixedWindow) Limit(ctx context.Context) (time.Duration, error)

+ type FixedWindowInMemory struct

+ func NewFixedWindowInMemory() *FixedWindowInMemory

+ func (f *FixedWindowInMemory) Increment(ctx context.Context, window time.Time, _ time.Duration) (int64, error)

+ type FixedWindowIncrementer interface

+ Increment func(ctx context.Context, window time.Time, ttl time.Duration) (int64, error)

+ type FixedWindowRedis struct

+ func NewFixedWindowRedis(cli *redis.Client, prefix string) *FixedWindowRedis

+ func (f *FixedWindowRedis) Increment(ctx context.Context, window time.Time, ttl time.Duration) (int64, error)

+ type LeakyBucket struct

+ func NewLeakyBucket(capacity int64, rate time.Duration, locker DistLocker, ...) *LeakyBucket

+ func (t *LeakyBucket) Limit(ctx context.Context) (time.Duration, error)

+ type LeakyBucketEtcd struct

+ func NewLeakyBucketEtcd(cli *clientv3.Client, prefix string, ttl time.Duration, raceCheck bool) *LeakyBucketEtcd

+ func (l *LeakyBucketEtcd) SetState(ctx context.Context, state LeakyBucketState) error

+ func (l *LeakyBucketEtcd) State(ctx context.Context) (LeakyBucketState, error)

+ type LeakyBucketInMemory struct

+ func NewLeakyBucketInMemory() *LeakyBucketInMemory

+ func (l *LeakyBucketInMemory) SetState(ctx context.Context, state LeakyBucketState) error

+ func (l *LeakyBucketInMemory) State(ctx context.Context) (LeakyBucketState, error)

+ type LeakyBucketRedis struct

+ func NewLeakyBucketRedis(cli *redis.Client, prefix string, ttl time.Duration, raceCheck bool) *LeakyBucketRedis

+ func (t *LeakyBucketRedis) SetState(ctx context.Context, state LeakyBucketState) error

+ func (t *LeakyBucketRedis) State(ctx context.Context) (LeakyBucketState, error)

+ type LeakyBucketState struct

+ Last int64

+ func (s LeakyBucketState) IzZero() bool

+ type LeakyBucketStateBackend interface

+ SetState func(ctx context.Context, state LeakyBucketState) error

+ State func(ctx context.Context) (LeakyBucketState, error)

+ type LockConsul struct

+ func NewLockConsul(lock *api.Lock) *LockConsul

+ func (l *LockConsul) Lock(ctx context.Context) error

+ func (l *LockConsul) Unlock() error

+ type LockEtcd struct

+ func NewLockEtcd(cli *clientv3.Client, prefix string, logger Logger) *LockEtcd

+ func (l *LockEtcd) Lock(ctx context.Context) error

+ func (l *LockEtcd) Unlock() error

+ type LockNoop struct

+ func NewLockNoop() *LockNoop

+ func (n LockNoop) Lock(ctx context.Context) error

+ func (n LockNoop) Unlock() error

+ type LockZookeeper struct

+ func NewLockZookeeper(lock *zk.Lock) *LockZookeeper

+ func (l *LockZookeeper) Lock(_ context.Context) error

+ func (l *LockZookeeper) Unlock() error

+ type Logger interface

+ Log func(v ...interface{})

+ type Registry struct

+ func NewRegistry() *Registry

+ func (r *Registry) Delete(key string)

+ func (r *Registry) DeleteExpired(now time.Time) int

+ func (r *Registry) Exists(key string) bool

+ func (r *Registry) GetOrCreate(key string, value func() interface{}, ttl time.Duration, now time.Time) interface{}

+ func (r *Registry) Len() int

+ type SlidingWindow struct

+ func NewSlidingWindow(capacity int64, rate time.Duration, ...) *SlidingWindow

+ func (s *SlidingWindow) Limit(ctx context.Context) (time.Duration, error)

+ type SlidingWindowInMemory struct

+ func NewSlidingWindowInMemory() *SlidingWindowInMemory

+ func (s *SlidingWindowInMemory) Increment(ctx context.Context, prev, curr time.Time, _ time.Duration) (int64, int64, error)

+ type SlidingWindowIncrementer interface

+ Increment func(ctx context.Context, prev, curr time.Time, ttl time.Duration) (prevCount, currCount int64, err error)

+ type SlidingWindowRedis struct

+ func NewSlidingWindowRedis(cli *redis.Client, prefix string) *SlidingWindowRedis

+ func (s *SlidingWindowRedis) Increment(ctx context.Context, prev, curr time.Time, ttl time.Duration) (int64, int64, error)

+ type StdLogger struct

+ func NewStdLogger() *StdLogger

+ func (l *StdLogger) Log(v ...interface{})

+ type SystemClock struct

+ func NewSystemClock() *SystemClock

+ func (c *SystemClock) Now() time.Time

+ func (c *SystemClock) Sleep(d time.Duration)

+ type TokenBucket struct

+ func NewTokenBucket(capacity int64, refillRate time.Duration, locker DistLocker, ...) *TokenBucket

+ func NewTokenBucketOpts(opts TokenBucketOpts) *TokenBucket

+ func (t *TokenBucket) Limit(ctx context.Context) (time.Duration, error)

+ func (t *TokenBucket) Take(ctx context.Context, tokens int64) (time.Duration, error)

+ type TokenBucketEtcd struct

+ func NewTokenBucketEtcd(cli *clientv3.Client, prefix string, ttl time.Duration, raceCheck bool) *TokenBucketEtcd

+ func (t *TokenBucketEtcd) SetState(ctx context.Context, state TokenBucketState) error

+ func (t *TokenBucketEtcd) State(ctx context.Context) (TokenBucketState, error)

+ type TokenBucketInMemory struct

+ func NewTokenBucketInMemory() *TokenBucketInMemory

+ func (t *TokenBucketInMemory) SetState(ctx context.Context, state TokenBucketState) error

+ func (t *TokenBucketInMemory) State(ctx context.Context) (TokenBucketState, error)

+ type TokenBucketOpts struct

+ type TokenBucketRedis struct

+ func NewTokenBucketRedis(cli *redis.Client, prefix string, ttl time.Duration, raceCheck bool) *TokenBucketRedis

+ func (t *TokenBucketRedis) SetState(ctx context.Context, state TokenBucketState) error

+ func (t *TokenBucketRedis) State(ctx context.Context) (TokenBucketState, error)

+ type TokenBucketState struct

+ Available int64

+ Last int64

+ type TokenBucketStateBackend interface

+ SetState func(ctx context.Context, state TokenBucketState) error

+ State func(ctx context.Context) (TokenBucketState, error)