ratelimit

Documentation

Index

• type Config
• type RateLimiter
  • func New(cfg Config) *RateLimiter
  • func (rl *RateLimiter) Close()
  • func (rl *RateLimiter) Handler(next http.Handler) http.Handler
• type RatePolicy

Types

type Config

type Config struct {
	TTL             time.Duration
	MaxEntries      int
	Policy          func(r *http.Request) (bucket string, pol RatePolicy, ok bool)
	IPManager       *zulu.IPManager
	CleanupInterval time.Duration
	SharedState     woos.SharedState
}

type RateLimiter

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

func New

func New(cfg Config) *RateLimiter

New instantiates a dynamic request throttling layer. Handles both local token buckets and shared cluster constraints automatically.

func (*RateLimiter) Close

func (rl *RateLimiter) Close()

Close terminates the background cleanup scheduler and flushes map data. Prevents memory leaks during proxy hot-reloads and shutdowns.

func (*RateLimiter) Handler

func (rl *RateLimiter) Handler(next http.Handler) http.Handler

Handler enforces endpoint request ceilings across incoming connections. Responds with 429 Too Many Requests instantly upon limit saturation.

type RatePolicy

type RatePolicy struct {
	Requests int
	Window   time.Duration
	Burst    int
	KeySpec  string
}