counter

Documentation

Index

• type Counter
  • func New(ttl time.Duration, opts ...Option) *Counter
  • func (c *Counter) DeleteExpired()
  • func (c *Counter) Get(key string, window time.Time) (int, error)
  • func (c *Counter) Increment(key string, currWindow time.Time) error
• type Option
  • func DisableAutoDeleteExpired() Option
  • func WithCapacity(capacity uint64) Option

Types

type Counter

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

Counter is a sliding window counter implemented with a TTL cache

func New

func New(ttl time.Duration, opts ...Option) *Counter

NewCounter creates a new Counter

func (*Counter) DeleteExpired

func (c *Counter) DeleteExpired()

DeleteExpired deletes expired items from the cache

func (*Counter) Get

func (c *Counter) Get(key string, window time.Time) (int, error)

Get returns the count for the given key and window

func (*Counter) Increment

func (c *Counter) Increment(key string, currWindow time.Time) error

Increment increments the count for the given key and window

type Option

type Option func(*Counter)

func DisableAutoDeleteExpired

func DisableAutoDeleteExpired() Option

DisableAutoDeleteExpired disables the automatic deletion of expired items

func WithCapacity

func WithCapacity(capacity uint64) Option

WithCapacity sets the maximum number of items to store in the cache