ratelimit

Documentation

Index

• Constants
• func New(rdb *redis.Client, key KeyFunc, errFunc ErrFunc) gin.HandlerFunc
• type ErrFunc
• type KeyFunc

Constants

const (
	HeaderReset     = "X-Ratelimit-Reset"
	HeaderLimit     = "X-Ratelimit-Limit"
	HeaderRemaining = "X-Ratelimit-Remaining"
)

Functions

func New

func New(rdb *redis.Client, key KeyFunc, errFunc ErrFunc) gin.HandlerFunc

New creates a distributed rate limiter middleware using redis for state management.

Types

type ErrFunc

type ErrFunc func(*gin.Context, error) (shouldReturn bool)

type KeyFunc

type KeyFunc func(*gin.Context) (key string, limit *int, err error)