golimiter

README

golimiter

This packages provides a key based limiter. Read more here.

Usage

go get

go get github.com/mrwaggel/golimiter

example

package main

import (
	"github.com/mrwaggel/golimiter"
	"time"
)

func main() {
	l := golimiter.New(4, time.Second*5)
	key := "a"

	l.Increment(key)
	l.Increment(key)
	l.Increment(key)

	l.Count(key)     // 3
	l.IsLimited(key) // false

	l.Increment(key)

	l.Count(key)     // 4
	l.IsLimited(key) // true

	time.Sleep(time.Second * 6)
	l.Count(key)     // 0
	l.IsLimited(key) // false
}

Documentation

Index

• func New(limit int, expiresAfter time.Duration) *limiterManager
• type Limiter

Functions

func New

func New(limit int, expiresAfter time.Duration) *limiterManager

New returns a limiter manager, this is thread safe but does not lock keys like transactions would.

limit: 			how many unexpired entries a key can have
expiresAfter: 	how long before an entry expires for a key
gcInterval: 	the interval when the underlying cache
				should remove expired keys

Types

type Limiter

type Limiter interface {
	// IsLimited checks if the given key is limited
	IsLimited(key interface{}) bool
	// Increment increments the counter
	Increment(key interface{})
	// Remove clears key from all limits
	Remove(key interface{})
	// Count returns the total amount of values
	// that are not expired
	Count(key interface{}) int
}

Limiter is an interface to the limiterManager structure. use New(int, time.Duration) to instantiate a new limiter. See limiterManager (scroll down) for more information.