ratelimit

Documentation

Index

• Variables
• func NewBuilder() middleware.MiddlewareBuilder
• func Server(opts ...Option) middleware.Middleware
• type Config
• type Option
  • func WithLimiter(limiter ratelimit.Limiter) Option

Variables

var ErrLimitExceed = errors.New(429, "service unavailable due to rate limit exceeded")

ErrLimitExceed is service unavailable due to rate limit exceeded.

Functions

func NewBuilder

func NewBuilder() middleware.MiddlewareBuilder

func Server

func Server(opts ...Option) middleware.Middleware

Server ratelimiter middleware

Types

type Config

type Config struct {
	Limiter string `json:"limiter" yaml:"limiter"`
}

type Option

type Option func(*options)

Option is ratelimit option.

func WithLimiter

func WithLimiter(limiter ratelimit.Limiter) Option

WithLimiter set Limiter implementation, default is bbr limiter