ratelimiter

Documentation

Index

• Variables
• func CheckRateLimit(ctx context.Context, keyType string, key string, limitConf *LimiterConfig, ...) (*time.Time, error)
• func GetBlockTime(block *time.Time) float64
• func GetEnvBoolean(key string) (bool, bool)
• func GetEnvLargeint(key string) (int64, bool)
• func GetEnvString(key string) (string, bool)
• func PrintfD(config *LimiterConfig, format string, keyType string, key string, a ...any) (n int, err error)
• func PrintfWD(config *LimiterConfig, format string, a ...any) (n int, err error)
• type LimiterConfig
  • func SetConfiguration(config *LimiterConfig) *LimiterConfig
  • func (c *LimiterConfig) GetRateLimiterRateConfigForToken(token string) (*RateConfig, bool)
• type RateConfig

Variables

var StFormat = "2006-01-02 15:04:05"

Functions

func CheckRateLimit

func CheckRateLimit(ctx context.Context, keyType string, key string, limitConf *LimiterConfig, rateConfig *RateConfig) (*time.Time, error)

func GetBlockTime

func GetBlockTime(block *time.Time) float64

func GetEnvBoolean

func GetEnvBoolean(key string) (bool, bool)

func GetEnvLargeint

func GetEnvLargeint(key string) (int64, bool)

func GetEnvString

func GetEnvString(key string) (string, bool)

func PrintfD

func PrintfD(config *LimiterConfig, format string, keyType string, key string, a ...any) (n int, err error)

func PrintfWD

func PrintfWD(config *LimiterConfig, format string, a ...any) (n int, err error)

Types

type LimiterConfig

type LimiterConfig struct {
	IP             *RateConfig                               `json:"ip"`
	Token          *RateConfig                               `json:"token"`
	CustomTokens   *map[string]*RateConfig                   `json:"tokens"`
	StorageAdapter adapters.RateLimitStorageAdapter          `json:"-"`
	ResponseWriter response_writer.RateLimiterResponseWriter `json:"-"`
	Debug          bool                                      `json:"debug"`
	DisableEnvs    bool                                      `json:"disableEnvs"`
}

func SetConfiguration

func SetConfiguration(config *LimiterConfig) *LimiterConfig

func (*LimiterConfig) GetRateLimiterRateConfigForToken

func (c *LimiterConfig) GetRateLimiterRateConfigForToken(token string) (*RateConfig, bool)

type RateConfig

type RateConfig struct {
	MaxRequestsPerSecond  int64 `json:"maxRequestsPerSecond"`
	BlockTimeMilliseconds int64 `json:"blockTimeMilliseconds"`
}