ratelimit

Documentation

Index

• type Config
  • func NewDefaultConfig() Config
• type Key
  • func (k Key) String() string
• type Rates
  • func New(requests, perNBlocks int) *Rates
  • func (r *Rates) Allow(key string) bool
  • func (r *Rates) Count(key string) int
  • func (r *Rates) NextBlock()

Types

type Config

type Config struct {
	// How many requests
	Requests int `description:" " long:"requests"`

	// In the last `PerNBlocks` blocks
	PerNBlocks int `description:" " long:"per-n-blocks"`
}

func NewDefaultConfig

func NewDefaultConfig() Config

NewDefaultConfig allows 500 requests in the last 10 blocks.

type Key

type Key []byte

func (Key) String

func (k Key) String() string

type Rates

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

func New

func New(requests, perNBlocks int) *Rates

func (*Rates) Allow

func (r *Rates) Allow(key string) bool

func (*Rates) Count

func (r *Rates) Count(key string) int

Count returns the number of requests recorded for a given key It returns -1 if the key has been not recorded or evicted.

func (*Rates) NextBlock

func (r *Rates) NextBlock()