limiter

Documentation

Index

• type Limiter
  • func New(maxRPS, minRPS int) (*Limiter, error)
  • func (l *Limiter) Limit() int
  • func (l *Limiter) Lower() int
  • func (l *Limiter) Raise() int
  • func (l *Limiter) Wait(ctx context.Context) error

Types

type Limiter

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

Limiter provides rate per second control

func New

func New(maxRPS, minRPS int) (*Limiter, error)

New returns initialized Limiter

func (*Limiter) Limit

func (l *Limiter) Limit() int

Limit returns the current RPS

func (*Limiter) Lower

func (l *Limiter) Lower() int

Lower reduces the RPS

func (*Limiter) Raise

func (l *Limiter) Raise() int

Raise increase the RPS

func (*Limiter) Wait

func (l *Limiter) Wait(ctx context.Context) error

Wait returns the rate.limiter Wait function