The highest tagged major version is
README
¶
ratelimiter
ratelimiter is a redis-based ratecounter and ratelimiter
Tutorial
package main
import (
"github.com/abo/ratelimiter"
)
...
func main() {
pool := newRedisPool("localhost:6379", "")
// Counter
counter := ratelimiter.NewCounter(pool, "rl:test", 10 * time.Minute, 15 * time.Second)
counter.Inc("click")
c, err := counter.Count("click")
// Limiter
limiter := ratelimiter.NewLimiter(pool, "rl:test", 1 * time.Hour, 15 * time.Minute, 100)
limiter.Inc("114.255.86.200")
rem, err := limiter.Remaining("114.255.86.200")
exceed, err := limiter.Exceeded("114.255.86.200")
}
Installation
Install ratelimiter using the "go get" command:
go get github.com/abo/ratelimiter
Documentation
Contributing
WELCOME
License
ratelimiter is available under the The MIT License (MIT).
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Counter ¶
type Counter struct {
// contains filtered or unexported fields
}
Counter count total occurs during a time window w, it will store occurs during every time slice s: (now ~ now - s), (now - s ~ now - 2*s)...
func NewCounter ¶
NewCounter create a new Counter
type Limiter ¶
type Limiter struct {
Counter
// contains filtered or unexported fields
}
Limiter a redis-based ratelimiter
func NewLimiter ¶
NewLimiter create a new redis-based ratelimiter the Limiter limits the rate to n times per w
Source Files
Click to show internal directories.
Click to hide internal directories.