rate

README

Rate

Package rate provides a rate limiter. It implements a classic token bucket algorithm, which can achieve functions such as http api speed limit and network bandwidth speed limit.

Documentation

Overview

Package rate provides a rate limiter. It implements a classic token bucket algorithm, which can achieve functions such as http api speed limit and network bandwidth speed limit.

Index

• type Limits
  • func NewLimits(r uint64, p time.Duration) *Limits
  • func (l *Limits) Peek(n uint64) bool
  • func (l *Limits) Wait(n uint64)

Types

type Limits

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

Limits represents a rate limiter that controls resource allocation over time.

func NewLimits

func NewLimits(r uint64, p time.Duration) *Limits

NewLimits creates a new rate limiter with rate r over period p.

func (*Limits) Peek

func (l *Limits) Peek(n uint64) bool

Peek glances there are enough resources (n) available.

func (*Limits) Wait

func (l *Limits) Wait(n uint64)

Wait ensures there are enough resources (n) available, blocking if necessary.