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

limiter

package

Go to main page

Versions in this module

v7

v7.0.2

Jun 22, 2024

v7.0.1

Sep 21, 2022

v7.0.0

Jul 6, 2022

Changes in this version

+ type ExpirableOptions struct

+ DefaultExpirationTTL time.Duration

+ ExpireJobInterval time.Duration

+ type Limiter struct

+ func New(generalExpirableOptions *ExpirableOptions) *Limiter

+ func (l *Limiter) DeleteExpiredTokenBuckets()

+ func (l *Limiter) ExecOnLimitReached(w http.ResponseWriter, r *http.Request)

+ func (l *Limiter) GetBasicAuthExpirationTTL() time.Duration

+ func (l *Limiter) GetBasicAuthUsers() []string

+ func (l *Limiter) GetBurst() int

+ func (l *Limiter) GetContextValue(contextValue string) []string

+ func (l *Limiter) GetContextValueEntryExpirationTTL() time.Duration

+ func (l *Limiter) GetContextValues() map[string][]string

+ func (l *Limiter) GetForwardedForIndexFromBehind() int

+ func (l *Limiter) GetHeader(header string) []string

+ func (l *Limiter) GetHeaderEntryExpirationTTL() time.Duration

+ func (l *Limiter) GetHeaders() map[string][]string

+ func (l *Limiter) GetIPLookups() []string

+ func (l *Limiter) GetIgnoreURL() bool

+ func (l *Limiter) GetMax() float64

+ func (l *Limiter) GetMessage() string

+ func (l *Limiter) GetMessageContentType() string

+ func (l *Limiter) GetMethods() []string

+ func (l *Limiter) GetOverrideDefaultResponseWriter() bool

+ func (l *Limiter) GetStatusCode() int

+ func (l *Limiter) GetTokenBucketExpirationTTL() time.Duration

+ func (l *Limiter) LimitReached(key string) bool

+ func (l *Limiter) RemoveBasicAuthUsers(basicAuthUsers []string) *Limiter

+ func (l *Limiter) RemoveContextValue(contextValue string) *Limiter

+ func (l *Limiter) RemoveContextValuesEntries(contextValue string, entriesForRemoval []string) *Limiter

+ func (l *Limiter) RemoveHeader(header string) *Limiter

+ func (l *Limiter) RemoveHeaderEntries(header string, entriesForRemoval []string) *Limiter

+ func (l *Limiter) SetBasicAuthExpirationTTL(ttl time.Duration) *Limiter

+ func (l *Limiter) SetBasicAuthUsers(basicAuthUsers []string) *Limiter

+ func (l *Limiter) SetBurst(burst int) *Limiter

+ func (l *Limiter) SetContextValue(contextValue string, entries []string) *Limiter

+ func (l *Limiter) SetContextValueEntryExpirationTTL(ttl time.Duration) *Limiter

+ func (l *Limiter) SetContextValues(contextValues map[string][]string) *Limiter

+ func (l *Limiter) SetForwardedForIndexFromBehind(forwardedForIndex int) *Limiter

+ func (l *Limiter) SetHeader(header string, entries []string) *Limiter

+ func (l *Limiter) SetHeaderEntryExpirationTTL(ttl time.Duration) *Limiter

+ func (l *Limiter) SetHeaders(headers map[string][]string) *Limiter

+ func (l *Limiter) SetIPLookups(ipLookups []string) *Limiter

+ func (l *Limiter) SetIgnoreURL(enabled bool) *Limiter

+ func (l *Limiter) SetMax(max float64) *Limiter

+ func (l *Limiter) SetMessage(msg string) *Limiter

+ func (l *Limiter) SetMessageContentType(contentType string) *Limiter

+ func (l *Limiter) SetMethods(methods []string) *Limiter

+ func (l *Limiter) SetOnLimitReached(fn func(w http.ResponseWriter, r *http.Request)) *Limiter

+ func (l *Limiter) SetOverrideDefaultResponseWriter(override bool)

+ func (l *Limiter) SetStatusCode(statusCode int) *Limiter

+ func (l *Limiter) SetTokenBucketExpirationTTL(ttl time.Duration) *Limiter

+ func (l *Limiter) Tokens(key string) int

Other modules containing this package

github.com/didip/tollbooth

github.com/didip/tollbooth/v5

github.com/didip/tollbooth/v6

github.com/didip/tollbooth/v8