ip

Documentation

Index

• type Option
  • func WithBucket(size int) Option
  • func WithExcludes(ips []string) Option
  • func WithMaxQuota(max int) Option
  • func WithSecondLimit(perSecond rate.Limit) Option
• type RateLimiter
  • func NewRateLimiter(opts ...Option) *RateLimiter
  • func (i *RateLimiter) Get(ip string) *rate.Limiter
  • func (i *RateLimiter) GetExcludes() []string
  • func (i *RateLimiter) Set(ip string) *rate.Limiter

Types

type Option

type Option func(*options)

Option is IpRateLimit option.

func WithBucket

func WithBucket(size int) Option

WithBucket max bucket num.

func WithExcludes

func WithExcludes(ips []string) Option

WithExcludes bursts of at most b tokens.

func WithMaxQuota

func WithMaxQuota(max int) Option

WithMaxQuota bursts of at most b tokens.

func WithSecondLimit

func WithSecondLimit(perSecond rate.Limit) Option

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

type RateLimiter

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

RateLimiter ip rate limiter

func NewRateLimiter

func NewRateLimiter(opts ...Option) *RateLimiter

func (*RateLimiter) Get

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 (*RateLimiter) GetExcludes

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

func (*RateLimiter) Set

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