rate

Documentation

Index

• Constants
• type Limit
  • func Every(interval time.Duration) Limit
• type Limiter
  • func NewLimiter(rate Limit, burst numTokens) *Limiter
  • func (rl *Limiter) Allow() bool
  • func (rl *Limiter) AllowN(n numTokens) bool
  • func (rl *Limiter) AllowStm(tx *stm.Tx) bool
  • func (rl *Limiter) Wait(ctx context.Context) error
  • func (rl *Limiter) WaitN(ctx context.Context, n int) error

Constants

const Inf = Limit(math.MaxFloat64)

Types

type Limit

type Limit float64

func Every

func Every(interval time.Duration) Limit

type Limiter

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

func NewLimiter

func NewLimiter(rate Limit, burst numTokens) *Limiter

func (*Limiter) Allow

func (rl *Limiter) Allow() bool

func (*Limiter) AllowN

func (rl *Limiter) AllowN(n numTokens) bool

func (*Limiter) AllowStm

func (rl *Limiter) AllowStm(tx *stm.Tx) bool

func (*Limiter) Wait

func (rl *Limiter) Wait(ctx context.Context) error

func (*Limiter) WaitN

func (rl *Limiter) WaitN(ctx context.Context, n int) error