tokenbucket

package

v0.0.0-...-9648343 Latest Latest Go to latest Published: Aug 7, 2021 License: BSD-3-Clause Imports: 1 Imported by: 0

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

Repository URL not available.

This section is empty.

This section is empty.

This section is empty.

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

Bucket represents a token bucket.

func New(interval time.Duration, refill, capa int) *Bucket

New initiates a token bucket with a maximum capacity that refills at a certain interval.

func (b *Bucket) Cap() int

func (b *Bucket) Delay() time.Duration

TODO: accurate compute for multiple takes

func (b *Bucket) Empty() bool

Empty checks whether the bucket is currently empty.

func (b *Bucket) Set(v int)

Set assigns a specific value to the bucket.

func (b *Bucket) SetInterval(i time.Duration)

SetInterval changes the refill interval. Mostly useful for testing.

func (b *Bucket) Take(i int) int

Take takes at most i tokens from the bucket.

func (b *Bucket) TakeOne() bool

TakeOne takes one token from the bucket.