rate

package module

v1.1.0 Latest Latest Go to latest Published: Apr 29, 2024 License: MIT Imports: 3 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/linkdata/rate

Links

Open Source Insights

README ¶

An efficient rate limiter for Go

Because too much of the CPU consumed was golang.org/x/time/rate.Limiter.Wait() calling time.Now().

Documentation ¶

Index ¶

func NewSubTicker(parent <-chan struct{}, rate *int32) <-chan struct{}
func NewTicker(ctx context.Context, rate *int32) <-chan struct{}
type Limiter
- func (rl *Limiter) Wait(rate *int32)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewSubTicker ¶ added in v1.1.0

func NewSubTicker(parent <-chan struct{}, rate *int32) <-chan struct{}

NewSubTicker returns a channel that reads from another struct{}{} channel and then sends a `struct{}{}` at most `*rate` times per second, but that cannot exceed the parent tick rate.

Use this to make "background" tickers that are less prioritized.

The channel is closed when the parent channel is closed.

func NewTicker ¶

func NewTicker(ctx context.Context, rate *int32) <-chan struct{}

NewTicker returns a channel that sends a `struct{}{}` at most `*rate` times per second.

A nil `rate` or a `*rate` of zero or less sends as quickly as possible.

The channel is closed when the context is done.

Types ¶

type Limiter ¶

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

Limiter provides efficient rate limiting. The zero value is immediately usable.

A Limiter is not safe to use from multiple goroutines simultaneously.

func (*Limiter) Wait ¶

func (rl *Limiter) Wait(rate *int32)

Wait sleeps at least long enough to ensure that the given `*rate` of events per second is not exceeded.

A nil `rate` or a `*rate` of zero or less doesn't wait at all.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL