rate

README

Rate Limiter

a generic event rate limiter by pure go

Interface

// Limiter controls how frequently events are allowed to happen
type Limiter interface {
    Take() error // Take take one token, if met error, must be ErrNoMoreTokens

    Remains() int // how many tokens remains, always used to check if reached limit line

    Taken() int // how many tokens has been taken

    SetLimit(w time.Duration, n int) // change limit settings on fly

    String() string // print limiter text message
}

Usage

See:

• case

Documentation

Index

• Variables
• type Limiter
  • func NewLimiter(w time.Duration, n int) Limiter

Variables

var (
	ErrNoMoreTokens = errors.New("no more tokens, pls wait and retry")
)

nolint

Types

type Limiter

type Limiter interface {
	Take() error // Take take one token, if met error, must be ErrNoMoreTokens

	Remains() int // how many tokens remains, always used to check if reached limit line

	Taken() int // how many tokens has been taken

	SetLimit(w time.Duration, n int) // change limit settings on fly

	String() string // print limiter text message
}

Limiter controls how frequently events are allowed to happen

func NewLimiter

func NewLimiter(w time.Duration, n int) Limiter

NewLimiter new a event limiter