counter

package

v0.10.0 Latest Latest Go to latest Published: Dec 16, 2023 License: MIT Imports: 4 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

Counter is a sliding window counter implemented with a TTL cache

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

NewCounter creates a new Counter

func (c *Counter) DeleteExpired()

DeleteExpired deletes expired items from the cache

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

Get returns the count for the given key and window

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

Increment increments the count for the given key and window

type Option func(*Counter)

func DisableAutoDeleteExpired() Option

DisableAutoDeleteExpired disables the automatic deletion of expired items

func WithCapacity(capacity uint64) Option

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