rate

Documentation

Overview

Package rate provides a rate limiter.

Index

• type Limit
  • func Every(interval time.Duration) Limit
• type Limiter
  • func NewLimiter(r Limit, b int) *Limiter
  • func (lim *Limiter) Allow() bool

Types

type Limit

type Limit float64

Limit defines the maximum frequency of some events. Limit is represented as number of events per second. A zero Limit is invalid.

func Every

func Every(interval time.Duration) Limit

Every converts a minimum time interval between events to a Limit.

type Limiter

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

A Limiter controls how frequently events are allowed to happen. It implements a "token bucket" of size b, initially full and refilled at rate r tokens per second. Informally, in any large enough time interval, the Limiter limits the rate to r tokens per second, with a maximum burst size of b events. See https://en.wikipedia.org/wiki/Token_bucket for more about token buckets. Use NewLimiter to create non-zero Limiters.

func NewLimiter

func NewLimiter(r Limit, b int) *Limiter

NewLimiter returns a new Limiter that allows events up to rate r and permits bursts of at most b tokens.

func (*Limiter) Allow

func (lim *Limiter) Allow() bool

AllowN reports whether an event may happen now.