ratelimit

Documentation

Index

• Variables
• type Ratelimit
  • func NewLimiter(ctx context.Context, name string) *Ratelimit
  • func (l *Ratelimit) Allow() (func(), error)
  • func (l *Ratelimit) Stat() stat

Variables

var (
	// ErrLimitExceed is returned when the rate limiter is
	// triggered and the request is rejected due to limit exceeded.
	ErrLimitExceed = errors.New("rate limit exceeded")
)

Types

type Ratelimit

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

Ratelimit implements bbr-like limiter. It is inspired by sentinel. https://github.com/alibaba/Sentinel/wiki/%E7%B3%BB%E7%BB%9F%E8%87%AA%E9%80%82%E5%BA%94%E9%99%90%E6%B5%81

func NewLimiter

func NewLimiter(ctx context.Context, name string) *Ratelimit

NewLimiter returns a bbr limiter

func (*Ratelimit) Allow

func (l *Ratelimit) Allow() (func(), error)

Allow checks all inbound traffic. Once overload is detected, it raises limit.ErrLimitExceed error.

func (*Ratelimit) Stat

func (l *Ratelimit) Stat() stat

Stat tasks a snapshot of the bbr limiter.