limit

Documentation

Index

• Constants
• Variables
• type PeriodLimit
  • func NewPeriodLimit(period, quota int, limitStore *rv8.Client, keyPrefix string, ...) *PeriodLimit
  • func (h *PeriodLimit) Take(key string) (int, error)
• type PeriodOption
  • func Align() PeriodOption

Constants

const (
	// Unknown means not initialized state.
	Unknown = iota
	// Allowed means allowed state.
	Allowed
	// HitQuota means this request exactly hit the quota.
	HitQuota
	// OverQuota means passed the quota.
	OverQuota
)

Variables

var ErrUnknownCode = errors.New("unknown status code")

ErrUnknownCode is an error that represents unknown status code.

Types

type PeriodLimit

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

A PeriodLimit is used to limit requests during a period of time.

func NewPeriodLimit

func NewPeriodLimit(period, quota int, limitStore *rv8.Client, keyPrefix string,
	opts ...PeriodOption) *PeriodLimit

NewPeriodLimit returns a PeriodLimit with given parameters.

func (*PeriodLimit) Take

func (h *PeriodLimit) Take(key string) (int, error)

Take requests a permit, it returns the permit state.

type PeriodOption

type PeriodOption func(l *PeriodLimit)

PeriodOption defines the method to customize a PeriodLimit.

func Align

func Align() PeriodOption

Align returns a func to customize a PeriodLimit with alignment. For example, if we want to limit end users with 5 sms verification messages every day, we need to align with the local timezone and the start of the day.