limiter

Documentation

Index

• type ClientLimiter
  • func NewClientLimiter(opts ClientLimiterOpts) *ClientLimiter
  • func (cl *ClientLimiter) AllowN(addr netip.Addr, now time.Time, n int) bool
  • func (cl *ClientLimiter) Close() error
• type ClientLimiterOpts

Types

type ClientLimiter

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

func NewClientLimiter

func NewClientLimiter(opts ClientLimiterOpts) *ClientLimiter

Creates a ClientLimiter. Note: Call ClientLimiter.Close() to stop its gc goroutine.

func (*ClientLimiter) AllowN

func (cl *ClientLimiter) AllowN(addr netip.Addr, now time.Time, n int) bool

func (*ClientLimiter) Close

func (cl *ClientLimiter) Close() error

Stop gc goroutine. Do not use this limiter once it was closed. Always return nil.

type ClientLimiterOpts

type ClientLimiterOpts struct {
	Limit  float64 // default 20
	Burst  int     // default is Qps
	V4Mask int     // default 24
	V6Mask int     // default 48
}