ratelimiter

Documentation

Index

• type InMemoryStore
  • func (s *InMemoryStore) Increment(key string) error
• type Limiter
• type RateLimiter
  • func DefaultRateLimiter(maxAmount int, validDuration time.Duration, logger lager.Logger) *RateLimiter
  • func NewRateLimiter(bucketCapacity int, maxAmount int, validDuration time.Duration, ...) *RateLimiter
  • func (r *RateLimiter) ExceedsLimit(key string) bool
• type RateLimiterMiddleware
  • func NewRateLimiterMiddleware(key string, rateLimiter Limiter, logger lager.Logger) *RateLimiterMiddleware
  • func (mw *RateLimiterMiddleware) CheckRateLimit(next http.Handler) http.Handler
• type Store
  • func NewStore(bucketCapacity int, maxAmount int, validDuration time.Duration, ...) Store

Types

type InMemoryStore

type InMemoryStore struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func (*InMemoryStore) Increment

func (s *InMemoryStore) Increment(key string) error

type Limiter

type Limiter interface {
	ExceedsLimit(string) bool
}

type RateLimiter

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

func DefaultRateLimiter

func DefaultRateLimiter(maxAmount int, validDuration time.Duration, logger lager.Logger) *RateLimiter

func NewRateLimiter

func NewRateLimiter(bucketCapacity int, maxAmount int, validDuration time.Duration, expireDuration time.Duration, expireCheckInterval time.Duration, logger lager.Logger) *RateLimiter

func (*RateLimiter) ExceedsLimit

func (r *RateLimiter) ExceedsLimit(key string) bool

type RateLimiterMiddleware

type RateLimiterMiddleware struct {
	Key string

	RateLimiter Limiter
	// contains filtered or unexported fields
}

func NewRateLimiterMiddleware

func NewRateLimiterMiddleware(key string, rateLimiter Limiter, logger lager.Logger) *RateLimiterMiddleware

func (*RateLimiterMiddleware) CheckRateLimit

func (mw *RateLimiterMiddleware) CheckRateLimit(next http.Handler) http.Handler

type Store

type Store interface {
	Increment(string) error
}

func NewStore

func NewStore(bucketCapacity int, maxAmount int, validDuration time.Duration, expireDuration time.Duration, expireCheckInterval time.Duration, logger lager.Logger) Store