ratelimiter

Documentation

Index

• Constants
• type JRateLimiter
  • func NewJRateLimiter(fillInterval time.Duration, capacity int64) (*JRateLimiter, error)
  • func NewJRateLimiterWithQuantum(fillInterval time.Duration, capacity, quantum int64) (*JRateLimiter, error)
  • func (l *JRateLimiter) JLimit() bool
• 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 (
	JOnceTakeCount = 1
	JOncePutCount  = 1
)

const (
	OnceTakeCount = 1
	OncePutCount  = 1
)

Types

type JRateLimiter

type JRateLimiter struct {
	ratelimit.Bucket
}

func NewJRateLimiter

func NewJRateLimiter(fillInterval time.Duration, capacity int64) (*JRateLimiter, 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 NewJRateLimiterWithQuantum

func NewJRateLimiterWithQuantum(fillInterval time.Duration, capacity, quantum int64) (*JRateLimiter, error)

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

func (*JRateLimiter) JLimit

func (l *JRateLimiter) JLimit() bool

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