throttle

Documentation

Overview

Package throttle 限流

Index

• func DefaultErrHandler(ctx zeroapi.Context, err error)
• func DefaultLimitHandler(ctx zeroapi.Context)
• func New(c *Config) zeroapi.Handler
• type Config
• type VaryBy
  • func DefaultVaryBy() VaryBy

Functions

func DefaultErrHandler

func DefaultErrHandler(ctx zeroapi.Context, err error)

DefaultErrHandler 默认的发生错误时调用

func DefaultLimitHandler

func DefaultLimitHandler(ctx zeroapi.Context)

DefaultLimitHandler 默认的发生限制时调用

func New

func New(c *Config) zeroapi.Handler

Types

type Config

type Config struct {
	// LimitHandler 发生限制时调用
	LimitHandler zeroapi.Handler

	// ErrHandler 发生错误时调用
	ErrHandler func(ctx zeroapi.Context, err error)

	// PerMin 每个请求每分钟请求的个数，> 0
	PerMin int

	// Burst 每一个请求每分钟允许额外请求的个数，> 0
	Burst int

	// VaryBy 为请求生成唯一值
	VaryBy VaryBy
}

Config 配置

type VaryBy

type VaryBy interface {
	Key(*http.Request) string
}

VaryBy 为请求生成唯一值

func DefaultVaryBy

func DefaultVaryBy() VaryBy

DefaultVaryBy 默认的 key 生成器