ratelimit

Documentation

Index

• type LimitOpts
  • func Apply(opts []Option) *LimitOpts
• type Limiter
• type Option
  • func WithFallback(fallback func(c *gin.Context)) Option
  • func WithResourceStrategy(strategy func(c *gin.Context) string) Option

Types

type LimitOpts

type LimitOpts struct {
	Strategy func(c *gin.Context) string
	Fallback func(c *gin.Context)
}

func Apply

func Apply(opts []Option) *LimitOpts

Apply applies the option to limiter

type Limiter

type Limiter interface {
	Allow(context.Context, string) bool
}

type Option

type Option func(*LimitOpts)

func WithFallback

func WithFallback(fallback func(c *gin.Context)) Option

WithFallback set the fallback handler when request is blocked

func WithResourceStrategy

func WithResourceStrategy(strategy func(c *gin.Context) string) Option

WithResourceStrategy set the verify path extract strategy of request