bucket

package

v0.0.0-...-5a170ab Latest Latest Go to latest Published: Mar 13, 2016 License: Apache-2.0 Imports: 2 Imported by: 8

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

bucket implements a generic, embeddable token bucket algorithm.

View Source

const (
	TPS       Rate = 1
	KTPS           = 1000 * TPS
	MTPS           = 1000 * KTPS
	GTPS           = 1000 * MTPS
	Unlimited      = 0
)

Common rates.

This section is empty.

This section is empty.

type Bucket struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Represents a token bucket. It is not thread safe.

func New(rate Rate, max uint64) (bucket *Bucket)

NewBucket creates a new bucket with the given rate and the maximum bucket size.

If rate is Unlimited, it returns a nil pointer and it is safe to call all Bucket methods on that nil pointer:

b := bucket.NewBucket(Unlimited)
b.Has(10)
b.Get(10)

func (b *Bucket) Get(tokens uint64) (ok bool)

Get allocates t tockens from the buffer if available, or otherwise returns false.

func (b *Bucket) Has(tokens uint64) (has bool)

Has returns whether the bucket has at least t tocken.

func (b *Bucket) Max() uint64

Max returns the maximum number of tokens that this bucket can store.

func (b *Bucket) Reset()

Reset reset the bucket to an empty bucket and starts adding tokens from now.

func (b *Bucket) Unlimited() bool

Unlimited returns whether the bucket is unlimited.

func (b *Bucket) When(tokens uint64) (dur time.Duration)

When returns the minimum time to wait before enough tokens are available.

type Rate uint64

Rate represents the rate of token generation per second.