rate_limit

Documentation

Index

• Constants
• type Option
  • func WithBurstLimit(burstLimit int) Option
  • func WithRateLimit(rateLimit int) Option
  • func WithRateLimitWindow(rateLimitWindow int) Option
• type Options
• type RateLimit
  • func New(options ...Option) *RateLimit
  • func (r *RateLimit) Provide(ctx context.Context) any
  • func (r *RateLimit) RateLimit(key string) (bool, error)

Constants

const LimitLuaScript = `` /* 249-byte string literal not displayed */

const (
	RateLimitIP = "rate:limit:ip_"
)

Types

type Option

type Option func(*Options)

func WithBurstLimit

func WithBurstLimit(burstLimit int) Option

func WithRateLimit

func WithRateLimit(rateLimit int) Option

func WithRateLimitWindow

func WithRateLimitWindow(rateLimitWindow int) Option

type Options

type Options struct {
	RateLimit       int // 每秒允许的最大请求数
	BurstLimit      int // 最大突发请求数
	RateLimitWindow int // 速率限制窗口大小，单位秒
}

type RateLimit

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

func New

func New(options ...Option) *RateLimit

func (*RateLimit) Provide

func (r *RateLimit) Provide(ctx context.Context) any

func (*RateLimit) RateLimit

func (r *RateLimit) RateLimit(key string) (bool, error)