ratelimit

Documentation

Overview

Package ratelimit implements the types.RateLimit interface for limiting access to resources shared service wide.

Index

• Constants
• Variables
• func Descriptions() string
• func New(conf Config, mgr types.Manager, log log.Modular, stats metrics.Type) (types.RateLimit, error)
• func NewLocal(conf Config, mgr types.Manager, logger log.Modular, stats metrics.Type) (types.RateLimit, error)
• func SanitiseConfig(conf Config) (interface{}, error)
• type Config
  • func NewConfig() Config
  • func (c *Config) UnmarshalJSON(bytes []byte) error
  • func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Local
  • func (r *Local) Access() (time.Duration, error)
• type LocalConfig
  • func NewLocalConfig() LocalConfig
• type TypeSpec

Constants

const (
	TypeLocal = "local"
)

String constants representing each ratelimit type.

Variables

var Constructors = map[string]TypeSpec{}

Constructors is a map of all cache types with their specs.

Functions

func Descriptions

func Descriptions() string

Descriptions returns a formatted string of descriptions for each type.

func New

func New(
	conf Config,
	mgr types.Manager,
	log log.Modular,
	stats metrics.Type,
) (types.RateLimit, error)

New creates a rate limit type based on an rate limit configuration.

func NewLocal

func NewLocal(
	conf Config,
	mgr types.Manager,
	logger log.Modular,
	stats metrics.Type,
) (types.RateLimit, error)

NewLocal creates a local rate limit from a configuration struct. This type is safe to share and call from parallel goroutines.

func SanitiseConfig

func SanitiseConfig(conf Config) (interface{}, error)

SanitiseConfig creates a sanitised version of a config.

Types

type Config

type Config struct {
	Type  string      `json:"type" yaml:"type"`
	Local LocalConfig `json:"local" yaml:"local"`
}

Config is the all encompassing configuration struct for all cache types.

func NewConfig

func NewConfig() Config

NewConfig returns a configuration struct fully populated with default values.

func (*Config) UnmarshalJSON

func (c *Config) UnmarshalJSON(bytes []byte) error

UnmarshalJSON ensures that when parsing configs that are in a map or slice the default values are still applied.

func (*Config) UnmarshalYAML

func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML ensures that when parsing configs that are in a map or slice the default values are still applied.

type Local

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

Local is a structure that tracks a rate limit, it can be shared across parallel processes in order to maintain a maximum rate of a protected resource.

func (*Local) Access

func (r *Local) Access() (time.Duration, error)

Access the rate limited resource. Returns a duration or an error if the rate limit check fails. The returned duration is either zero (meaning the resource can be accessed) or a reasonable length of time to wait before requesting again.

type LocalConfig

type LocalConfig struct {
	Count    int    `json:"count" yaml:"count"`
	Interval string `json:"interval" yaml:"interval"`
}

LocalConfig is a config struct containing rate limit fields for a local rate limit.

func NewLocalConfig

func NewLocalConfig() LocalConfig

NewLocalConfig returns a local rate limit configuration struct with default values.

type TypeSpec

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

TypeSpec is a constructor and a usage description for each ratelimit type.