ratelimiter

Documentation

Index

• type Ratelimiter
  • func (rate *Ratelimiter) Allow(ip netip.Addr) bool
  • func (rate *Ratelimiter) Close()
  • func (rate *Ratelimiter) Init(spawner Spawner)
• type RatelimiterEntry
• type Spawner

Types

type Ratelimiter

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

func (*Ratelimiter) Allow

func (rate *Ratelimiter) Allow(ip netip.Addr) bool

func (*Ratelimiter) Close

func (rate *Ratelimiter) Close()

func (*Ratelimiter) Init

func (rate *Ratelimiter) Init(spawner Spawner)

Init resets the limiter and starts its garbage-collection worker.

When spawner is non-nil, the worker is started through it so callers can observe the same lifecycle as other long-lived networking workers.

type RatelimiterEntry

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

type Spawner

type Spawner interface {
	Spawn(worker func(), name string) (uint64, error)
}

Spawner starts long-lived background workers. It matches gonnect.Spawner's Spawn method without making this package depend on gonnect directly.