ratelimiter

Documentation

Index

• Variables
• type DoneFunc
• type DoneInfo
• type RateLimiter

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 DoneFunc

type DoneFunc func(DoneInfo)

DoneFunc is done function.

type DoneInfo

type DoneInfo struct {
	Err error
}

DoneInfo is done info.

type RateLimiter

type RateLimiter interface {
	Allow() (DoneFunc, error)
}

RateLimiter is a rate limiter.