ttlset

Documentation

Index

• type Config
• type TTLSet
  • func New(config *Config) *TTLSet
  • func (ts *TTLSet) Add(key interface{}) error
  • func (ts *TTLSet) Count() int
  • func (ts *TTLSet) GC()
  • func (ts *TTLSet) Has(key interface{}) bool

Types

type Config

type Config struct {
	EntryTTL time.Duration // time after which items are removed
	Clock    clock.Clock   // time reference
}

Config defines the TTLSet configuration

type TTLSet

type TTLSet struct {
	Config
	// contains filtered or unexported fields
}

TTLSet implements a Set that automatically removes expired keys after a predefined expiration time

func New

func New(config *Config) *TTLSet

New instances a TTLSet

func (*TTLSet) Add

func (ts *TTLSet) Add(key interface{}) error

Add adds a new key to the set

func (*TTLSet) Count

func (ts *TTLSet) Count() int

Count returns the number of entries in the set

func (*TTLSet) GC

func (ts *TTLSet) GC()

GC will remove expired entries from the set

func (*TTLSet) Has

func (ts *TTLSet) Has(key interface{}) bool

Has returns whether or not a key is already/still in the set