limiter

Documentation

Index

• Constants
• type Limit
  • func PerHour(rate int) Limit
  • func PerMinute(rate int) Limit
  • func PerSecond(rate int) Limit
  • func (l Limit) String() string
• type Limiter
• type Result

Constants

const KeyPrefix = "hyper:limiter:"

KeyPrefix the prefix of key

Types

type Limit

type Limit struct {
	Rate   int
	Burst  int
	Period time.Duration
}

Limit struct define Limit

func PerHour

func PerHour(rate int) Limit

PerHour return limit base per hour

func PerMinute

func PerMinute(rate int) Limit

PerMinute return limit base per minute

func PerSecond

func PerSecond(rate int) Limit

PerSecond return limit base per second

func (Limit) String

func (l Limit) String() string

type Limiter

type Limiter interface {
	Acquire(string, Limit) (Result, error)
}

Limiter interface

type Result

type Result struct {
	Limit      Limit
	Acquired   bool
	Remaining  int
	RetryAfter int
	ResetAfer  int
}

Result define the result of acquire lock