rate_limiter

Documentation

Index

• type Limiter
  • func NewRateLimiter(limit rate.Limit, burst int) *Limiter
  • func (l *Limiter) Allow(unmappedAddr netip.Addr) bool
  • func (l *Limiter) Close() error
  • func (l *Limiter) ForEach(doFunc func(unmappedAddr netip.Addr, r *rate.Limiter) (doBreak bool)) (doBreak bool)
  • func (l *Limiter) Len() int

Types

type Limiter

type Limiter struct {
	// Limit and Burst are read-only.
	Limit rate.Limit
	Burst int
	// contains filtered or unexported fields
}

func NewRateLimiter

func NewRateLimiter(limit rate.Limit, burst int) *Limiter

NewRateLimiter creates a new client rate limiter. limit and burst should be greater than zero. See rate.Limiter for more details. Limiter has a internal gc which will run and remove old client entries every 1m. If the token refill time (burst/limit) is greater than 1m, the actual average qps limit may be higher than expected because the client status may be deleted and re-initialized.

func (*Limiter) Allow

func (l *Limiter) Allow(unmappedAddr netip.Addr) bool

maskedUnmappedP must be a masked prefix and contain a unmapped addr.

func (*Limiter) Close

func (l *Limiter) Close() error

func (*Limiter) ForEach

func (l *Limiter) ForEach(doFunc func(unmappedAddr netip.Addr, r *rate.Limiter) (doBreak bool)) (doBreak bool)

func (*Limiter) Len

func (l *Limiter) Len() int

Len returns current number of entries in the Limiter.