ratelimit

README

ratelimit

A Golang rate limit implementation

Documentation

Index

• type Limiter
  • func New(ctx context.Context, max int64, duration time.Duration) *Limiter
  • func NewUnlimited(ctx context.Context) *Limiter
  • func (rateLimiter *Limiter) Take()

Types

type Limiter

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

Limiter allows a burst of request during the defined duration

func New

func New(ctx context.Context, max int64, duration time.Duration) *Limiter

New creates a new limiter instance with the tokens amount and the interval

func NewUnlimited

func NewUnlimited(ctx context.Context) *Limiter

NewUnlimited create a bucket with approximated unlimited tokens

func (*Limiter) Take

func (rateLimiter *Limiter) Take()

Take one token from the bucket