ip

package

v2.0.61 Latest Latest Go to latest Published: Apr 24, 2024 License: Apache-2.0 Imports: 3 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Option func(*options)

Option is IpRateLimit option.

func WithBucket(size int) Option

WithBucket max bucket num.

func WithExcludes(ips []string) Option

WithExcludes bursts of at most b tokens.

func WithMaxQuota(max int) Option

WithMaxQuota bursts of at most b tokens.

func WithSecondLimit(perSecond rate.Limit) Option

WithSecondLimit with Limit is represented as number of events per second.

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

RateLimiter ip rate limiter

func NewRateLimiter(opts ...Option) *RateLimiter

func (i *RateLimiter) Get(ip string) *rate.Limiter

Get returns the rate limiter for the provided IP address if it exists. Otherwise, calls AddIP to add IP address to the map

func (i *RateLimiter) GetExcludes() []string

func (i *RateLimiter) Set(ip string) *rate.Limiter

Set creates a new rate limiter and adds it to the ips map, using the IP address as the key