ratelimiter

Documentation

Index

• type Info
  • func (i Info) IsExceeded() bool
  • func (i Info) Limit() int64
  • func (i Info) Remaining() int64
  • func (i Info) Resets() time.Duration
• type RateLimiter
  • func New(client *redis.Client, rate int64, duration time.Duration) *RateLimiter
  • func (r *RateLimiter) AddAndCheckIfExceeds(ctx context.Context, ip net.IP) (Info, error)

Types

type Info

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

func (Info) IsExceeded

func (i Info) IsExceeded() bool

func (Info) Limit

func (i Info) Limit() int64

func (Info) Remaining

func (i Info) Remaining() int64

func (Info) Resets

func (i Info) Resets() time.Duration

type RateLimiter

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

func New

func New(client *redis.Client, rate int64, duration time.Duration) *RateLimiter

func (*RateLimiter) AddAndCheckIfExceeds

func (r *RateLimiter) AddAndCheckIfExceeds(ctx context.Context, ip net.IP) (Info, error)