rate

Documentation

Overview

Package rate provides a rate limiter hooker, this package is based on golang.org/x/time/rate

Index

• type Limiter
  • func NewLimiter(interval time.Duration, burst int) *Limiter
  • func (lim *Limiter) Acquire() bool
  • func (lim *Limiter) AcquireN(n int) bool
  • func (lim *Limiter) Tokens() float64
• type LimiterManager
  • func NewManager(interval time.Duration, burst int) *LimiterManager
  • func (l *LimiterManager) Load(key interface{}) *Limiter

Types

type Limiter

type Limiter struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Limiter controls the frequency of handling events.

func NewLimiter

func NewLimiter(interval time.Duration, burst int) *Limiter

NewLimiter returns a new Limiter Pointer.

func (*Limiter) Acquire

func (lim *Limiter) Acquire() bool

Acquire ...

func (*Limiter) AcquireN

func (lim *Limiter) AcquireN(n int) bool

AcquireN ...

func (*Limiter) Tokens

func (lim *Limiter) Tokens() float64

Tokens returns the left token of limiter.

type LimiterManager

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

LimiterManager ...

func NewManager

func NewManager(interval time.Duration, burst int) *LimiterManager

NewManager ..

func (*LimiterManager) Load

func (l *LimiterManager) Load(key interface{}) *Limiter

Load ...