ratelimit

Documentation

Index

• Constants
• func OnRulesUpdate(rules []*Rule)
• type Config
  • func GetMockedRateLimitConfig() *Config
• type Filter
  • func (f *Filter) Decode(hc *contexthttp.HttpContext) filter.FilterStatus
• type FilterFactory
  • func (factory *FilterFactory) Apply() error
  • func (factory *FilterFactory) Config() interface{}
  • func (factory *FilterFactory) PrepareFilterChain(ctx *contexthttp.HttpContext, chain filter.FilterChain) error
• type Plugin
  • func (p *Plugin) CreateFilterFactory() (filter.HttpFilterFactory, error)
  • func (p *Plugin) Kind() string
• type Rule

Constants

const (
	Kind = constant.HTTPRateLimitFilter
)

Functions

func OnRulesUpdate

func OnRulesUpdate(rules []*Rule)

OnRulesUpdate update rule

Types

type Config

type Config struct {
	Resources []*pkgs.Resource `json:"resources,omitempty" yaml:"resources,omitempty"`
	Rules     []*Rule          `json:"rules,omitempty" yaml:"rules,omitempty"`
	LogPath   string           `json:"logPath,omitempty" yaml:"logPath,omitempty"`
}

Config rate limit config

func GetMockedRateLimitConfig

func GetMockedRateLimitConfig() *Config

type Filter

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

Filter is http filter instance

func (*Filter) Decode

func (f *Filter) Decode(hc *contexthttp.HttpContext) filter.FilterStatus

type FilterFactory

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

FilterFactory is http filter instance

func (*FilterFactory) Apply

func (factory *FilterFactory) Apply() error

func (*FilterFactory) Config

func (factory *FilterFactory) Config() interface{}

func (*FilterFactory) PrepareFilterChain

func (factory *FilterFactory) PrepareFilterChain(ctx *contexthttp.HttpContext, chain filter.FilterChain) error

type Plugin

type Plugin struct {
}

Plugin is http filter plugin.

func (*Plugin) CreateFilterFactory

func (p *Plugin) CreateFilterFactory() (filter.HttpFilterFactory, error)

func (*Plugin) Kind

func (p *Plugin) Kind() string

type Rule

type Rule struct {
	ID       int64     `json:"id,omitempty" yaml:"id,omitempty"`
	FlowRule flow.Rule `json:"flowRule,omitempty" yaml:"flowRule,omitempty"`
	Enable   bool      `json:"enable,omitempty" yaml:"enable,omitempty"`
}

Rule api group 's rate-limit rule