freebie

Documentation

Index

• type Count
• type DB
  • func NewMemIPMaskStore(numFreebies Count) DB

Types

type Count

type Count uint16

type DB

type DB interface {
	CanPass(*http.Request, net.IP) (bool, error)

	TallyFreebie(*http.Request, net.IP) (bool, error)
}

DB is the main interface of the package freebie. It represents a store that keeps track of how many free requests a certain IP address can make to a certain resource.

func NewMemIPMaskStore

func NewMemIPMaskStore(numFreebies Count) DB

NewMemIPMaskStore creates a new in-memory freebie store that masks the last byte of an IP address to keep track of free requests. The last byte of the address is discarded for the mapping to reduce risk of abuse by users that have a whole range of IPs at their disposal.