memstore

Documentation

Index

• Constants
• func NewOptionFactory(burst, requests cfgmodel.Int, duration cfgmodel.Str, ...) (optionName string, _ ratelimit.OptionFactoryFunc)
• func WithGCRA(maxKeys int, duration rune, requests, burst int, scopeIDs ...scope.TypeID) ratelimit.Option

Constants

const OptionName = `memstore`

OptionName identifies this package within the register of the backendratelimit.Backend type.

Functions

func NewOptionFactory

func NewOptionFactory(burst, requests cfgmodel.Int, duration cfgmodel.Str, gcraMaxMemoryKeys cfgmodel.Int) (optionName string, _ ratelimit.OptionFactoryFunc)

NewOptionFactory creates a new option factory function for the memstore in the backend package to be used for automatic scope based configuration initialization. Configuration values are read from package backendratelimit.Configuration.

func WithGCRA

func WithGCRA(maxKeys int, duration rune, requests, burst int, scopeIDs ...scope.TypeID) ratelimit.Option

WithGCRA creates a memory based GCRA rate limiter. Duration: (s second,i minute,h hour,d day). GCRA => https://en.wikipedia.org/wiki/Generic_cell_rate_algorithm This function implements a debug log.