ratelimiter

Documentation

Index

• Constants
• type RateLimiter
  • func NewRateLimiter(fillInterval time.Duration, capacity int64) (*RateLimiter, error)
  • func NewRateLimiterWithQuantum(fillInterval time.Duration, capacity, quantum int64) (*RateLimiter, error)
  • func (l *RateLimiter) Limit() bool

Constants

const (
	OnceTakeCount = 1
	OncePutCount  = 1
)

Types

type RateLimiter

type RateLimiter struct {
	ratelimit.Bucket
}

func NewRateLimiter

func NewRateLimiter(fillInterval time.Duration, capacity int64) (*RateLimiter, error)

returns a new token bucket that fills at the rate of one token every fillInterval, up to the given maximum capacity.Both arguments must be positive. The bucket is initially full.

func NewRateLimiterWithQuantum

func NewRateLimiterWithQuantum(fillInterval time.Duration, capacity, quantum int64) (*RateLimiter, error)

allows the specification of the quantum size - quantum tokens are added every fillInterval.

func (*RateLimiter) Limit

func (l *RateLimiter) Limit() bool