bandwidth

Documentation

Index

• type Bucket
  • func NewBucket(limit int64, interval time.Duration) (*Bucket, error)
  • func (rl *Bucket) Wait(n int64)
• type Limiter
  • func NewLimiter(limit int64) (*Limiter, error)
  • func (l *Limiter) Wait(n int)

Types

type Bucket

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

Bucket implements a thread-safe leaky bucket rate limiter.

func NewBucket

func NewBucket(limit int64, interval time.Duration) (*Bucket, error)

NewBucket creates a new rate limiter with the specified limit and interval.

func (*Bucket) Wait

func (rl *Bucket) Wait(n int64)

Wait blocks until n tokens are available. It allows waiting for amounts larger than the limit.

type Limiter

type Limiter struct {
	*Bucket
}

Limiter wrapper around standard rate.Limiter.

func NewLimiter

func NewLimiter(limit int64) (*Limiter, error)

NewLimiter returns new bandwidth limiter.

func (*Limiter) Wait

func (l *Limiter) Wait(n int)

Wait blocks until limiter permits n events to happen.