ratelimit

README

Ratelimit

Algorithms

• bbr

Documentation

Index

• Variables
• type Done
• type DoneInfo
• type Group
  • func (g *Group) Do(name string, fn func() error, fbs ...func(error) error) error
  • func (g *Group) Get(name string) Limiter
• type Limiter

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 Done

type Done func(DoneInfo)

Done is done function.

type DoneInfo

type DoneInfo struct {
	Err error
}

DoneInfo is done info.

type Group

type Group struct {
	New func() Limiter
	// contains filtered or unexported fields
}

Group .

func (*Group) Do

func (g *Group) Do(name string, fn func() error, fbs ...func(error) error) error

Do runs your function in a synchronous manner, blocking until either your function succeeds or an error is returned, including circuit errors.

func (*Group) Get

func (g *Group) Get(name string) Limiter

Get .

type Limiter

type Limiter interface {
	Allow() (Done, error)
}

Limiter is a rate limiter.