limit

Documentation

Index

• Constants
• Variables
• type PeriodLimit
  • func NewPeriodLimit(period, quota int, limitStore *redis.Client, keyPrefix string, ...) *PeriodLimit
  • func (h *PeriodLimit) ParsePermitState(code int) bool
  • func (h *PeriodLimit) Take(key string) (int, error)
  • func (h *PeriodLimit) TakeCtx(ctx context.Context, 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 is an error that represents unknown status code
	ErrUnknownCode = errors.New("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 *redis.Client, keyPrefix string,
	opts ...PeriodOption) *PeriodLimit

NewPeriodLimit returns a PeriodLimit with given parameters

func (*PeriodLimit) ParsePermitState

func (h *PeriodLimit) ParsePermitState(code int) bool

ParsePermitState returns the permit state by the code

func (*PeriodLimit) Take

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

Take requests a permit, it returns the permit state

func (*PeriodLimit) TakeCtx

func (h *PeriodLimit) TakeCtx(ctx context.Context, key string) (int, error)

TakeCtx requests a permit with context, 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