rate

Documentation

Index

• Variables
• type Config
• type IpLimiter
  • func NewIpLimiter(rate rate.Limit, burst int) *IpLimiter
  • func (l *IpLimiter) Allow(ip string, n int) bool
  • func (l *IpLimiter) GC(timeout time.Duration)
  • func (l *IpLimiter) Update(option Option) bool
• type Option
  • func NewOption(r int, b int) Option
• type Registry
  • func NewRegistry() *Registry
  • func (m *Registry) AutoReload(interval time.Duration, reloader func() *Config)
  • func (m *Registry) GC(timeout time.Duration)
  • func (m *Registry) Get(name string) (*IpLimiter, bool)
  • func (m *Registry) GetOrRegister(name string, rate rate.Limit, burst int) *IpLimiter
  • func (m *Registry) WhiteListed(name string) bool

Variables

var DefaultRegistryCfx = NewRegistry()

var DefaultRegistryEth = NewRegistry()

Types

type Config

type Config struct {
	IpLimitOpts map[string]Option   // ip rate limit configs
	WhiteList   map[string]struct{} // white list
}

type IpLimiter

type IpLimiter struct {
	Option
	// contains filtered or unexported fields
}

IpLimiter is used to limit requests from different users.

func NewIpLimiter

func NewIpLimiter(rate rate.Limit, burst int) *IpLimiter

func (*IpLimiter) Allow

func (l *IpLimiter) Allow(ip string, n int) bool

func (*IpLimiter) GC

func (l *IpLimiter) GC(timeout time.Duration)

func (*IpLimiter) Update

func (l *IpLimiter) Update(option Option) bool

type Option

type Option struct {
	Rate  rate.Limit
	Burst int
}

func NewOption

func NewOption(r int, b int) Option

type Registry

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

func NewRegistry

func NewRegistry() *Registry

func (*Registry) AutoReload

func (m *Registry) AutoReload(interval time.Duration, reloader func() *Config)

func (*Registry) GC

func (m *Registry) GC(timeout time.Duration)

func (*Registry) Get

func (m *Registry) Get(name string) (*IpLimiter, bool)

func (*Registry) GetOrRegister

func (m *Registry) GetOrRegister(name string, rate rate.Limit, burst int) *IpLimiter

func (*Registry) WhiteListed

func (m *Registry) WhiteListed(name string) bool