Rate limit

Technical reference of Rate limit.

This API is used in Rate limit.

Symbols

RateLimitAll

Declaration:

const RateLimitAll = "ALL"

RateLimitAll defines a constant value of the API.

RateLimitFilter

Declaration:

type RateLimitFilter string

RateLimitFilter defines a public type of API.

RateLimitFilterIP

Declaration:

RateLimitFilterIP      RateLimitFilter = "ip"

RateLimitFilterIP defines a constant value of the API.

RateLimitFilterSession

Declaration:

RateLimitFilterSession RateLimitFilter = "session"

RateLimitFilterSession defines a constant value of the API.

RateLimitFilterRoute

Declaration:

RateLimitFilterRoute   RateLimitFilter = "route"

RateLimitFilterRoute defines a constant value of the API.

RateLimitFilterMethod

Declaration:

RateLimitFilterMethod  RateLimitFilter = "method"

RateLimitFilterMethod defines a constant value of the API.

RateLimitFilterURL

Declaration:

RateLimitFilterURL     RateLimitFilter = "url"

RateLimitFilterURL defines a constant value of the API.

RateLimitConfig

Declaration:

type RateLimitConfig struct {
	Enabled bool
	Rules   []RateLimitRule
}

RateLimitConfig defines a public type of API.

Fields

RateLimitRule

Declaration:

type RateLimitRule struct {
	Name    string
	Enabled bool
	Methods []string
	Match   string
	Pattern string
	Limits  []RateLimitLimit
}

RateLimitRule defines a public type of API.

Fields

RateLimitLimit

Declaration:

type RateLimitLimit struct {
	Name     string
	Enabled  bool
	By       []RateLimitFilter
	Strategy RateLimitStrategy
}

RateLimitLimit defines a public type of API.

Fields

RateLimitStrategy

Declaration:

type RateLimitStrategy interface {
	rateLimitStrategy()
}

RateLimitStrategy defines a public type of API.

RateLimitFixedWindow

Declaration:

type RateLimitFixedWindow struct {
	Limit  int
	Window time.Duration
}

RateLimitFixedWindow defines a public type of API.

Fields

RateLimitSlidingWindow

Declaration:

type RateLimitSlidingWindow struct {
	Limit  int
	Window time.Duration
}

RateLimitSlidingWindow defines a public type of API.

Fields

RateLimitTokenBucket

Declaration:

type RateLimitTokenBucket struct {
	Every  time.Duration
	Refill int
	Burst  int
}

RateLimitTokenBucket defines a public type of API.

Fields

RateLimitLeakyBucket

Declaration:

type RateLimitLeakyBucket struct {
	Every    time.Duration
	Drain    int
	Capacity int
}

RateLimitLeakyBucket defines a public type of API.

Fields

See also

• Rate limit