leakybucket

README

leakybucket

A size-limited hash-map implementation of the leaky bucket rate-limiting algorithm

Documentation

Index

• Constants
• type Cache
  • func New(maxEntries int) *Cache
  • func (lb *Cache) Put(key uint64, quantity, limit int64) (int64, bool, bool)
  • func (lb *Cache) PutString(ks string, quantity, limit int64) (int64, bool, bool)

Constants

const (
	// DrainPerSecond is the number of tokens per second drained from each bucket
	DrainPerSecond = 1000000000
)

Types

type Cache

type Cache struct {
	MaxEntries int
	// contains filtered or unexported fields
}

Cache is a size-limited hash-map implementation of the leaky bucket rate-limiting algorithm. Entries are roughly 78 bytes each.

func New

func New(maxEntries int) *Cache

New creates a Cache capable of storing up to maxEntries entries.

func (*Cache) Put

func (lb *Cache) Put(key uint64, quantity, limit int64) (int64, bool, bool)

Put attempts to add quantity tokens into the bucket referred to by a uint64 key that has a size limit of limit tokens. Return the current number of tokens in the bucket, whether the key already existed, and whether there was enough room in the bucket to add the requested number of tokens.

func (*Cache) PutString

func (lb *Cache) PutString(ks string, quantity, limit int64) (int64, bool, bool)

PutString attempt to add quantity tokens into the bucket referred to the string ks that has a size limit of limit tokens. Return the current number of tokens in the bucket, whether the key already existed, and whether there was enough room in the bucket to add the requested number of tokens.