ratelimit

package

v1.1.2 Latest Latest Go to latest Published: Mar 2, 2026 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/eugenioenko/autentico

Links

Open Source Insights

Documentation ¶

Index ¶

type Store
- func NewStore(rps float64, burst int, rpm float64, burstPerMin int) *Store
- func (s *Store) Allow(ip string) bool
- func (s *Store) Cleanup(maxAge time.Duration)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Store ¶

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

Store is an in-memory, per-IP two-tier rate limiter. Each IP gets a short-term (per-second) and a long-term (per-minute) token bucket. A request must pass both to be allowed. Entries are evicted by Cleanup after being idle for a configurable duration.

func NewStore ¶

func NewStore(rps float64, burst int, rpm float64, burstPerMin int) *Store

NewStore creates a Store with a per-second and per-minute limit. Pass rps <= 0 to disable rate limiting entirely (Allow always returns true).

func (*Store) Allow ¶

func (s *Store) Allow(ip string) bool

Allow reports whether the given IP is within both rate limits.

func (*Store) Cleanup ¶

func (s *Store) Cleanup(maxAge time.Duration)

Cleanup removes entries that have not been seen within maxAge. Call this periodically to prevent unbounded memory growth.

Source Files ¶

View all Source files

ratelimit.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL