ratelimiter

Documentation

Index

• type RateLimiter
  • func New(rps int) *RateLimiter
  • func (l *RateLimiter) Allow() bool
  • func (l *RateLimiter) AllowN(n int) bool
  • func (l *RateLimiter) Limit() int
  • func (l *RateLimiter) WaitN(ctx context.Context, n int) (err error)

Types

type RateLimiter

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

func New

func New(rps int) *RateLimiter

New returns a new Limiter that allows events up to r requests per second.

func (*RateLimiter) Allow

func (l *RateLimiter) Allow() bool

Allow returns true if the request should be allowed.

func (*RateLimiter) AllowN

func (l *RateLimiter) AllowN(n int) bool

AllowN returns true if N requests should be allowed.

func (*RateLimiter) Limit

func (l *RateLimiter) Limit() int

Limit returns the maximum overall event rate. Zero is returned when there is no limit specified.

func (*RateLimiter) WaitN

func (l *RateLimiter) WaitN(ctx context.Context, n int) (err error)

WaitN blocks until it permits n events to happen