ttlcache

Documentation

Index

• type Cache
  • func NewCache(duration time.Duration, interval time.Duration) *Cache
  • func (cache *Cache) ContainsKey(key string) (found bool)
  • func (cache *Cache) ContainsKeyAndUpdate(key string, value string) (found bool)
  • func (cache *Cache) Count() int
  • func (cache *Cache) Get(key string) (data string, found bool)
  • func (cache *Cache) Set(key string, data string)
  • func (cache *Cache) SetWithTtl(key string, data string, duration time.Duration)
  • func (cache *Cache) ToStringMap() map[string]string
  • func (cache *Cache) ToValueArray() []string
• type Item

Types

type Cache

type Cache struct {
	Mutex       sync.RWMutex
	Ttl         time.Duration
	TtlInterval time.Duration
	Items       map[string]*Item
}

Cache is a synchronised map of Items that auto-expire once stale https://github.com/microsoftarchive/ttlcache @Description:

func NewCache

func NewCache(duration time.Duration, interval time.Duration) *Cache

NewCache is a helper to create instance of the Cache struct

func (*Cache) ContainsKey

func (cache *Cache) ContainsKey(key string) (found bool)

Set is a thread-safe way to add new Items to the map

func (*Cache) ContainsKeyAndUpdate

func (cache *Cache) ContainsKeyAndUpdate(key string, value string) (found bool)

Set is a thread-safe way to add new Items to the map

func (*Cache) Count

func (cache *Cache) Count() int

Count returns the number of Items in the cache (helpful for tracking memory leaks)

func (*Cache) Get

func (cache *Cache) Get(key string) (data string, found bool)

Get is a thread-safe way to lookup Items Every lookup, also touches the item, hence extending it's life

func (*Cache) Set

func (cache *Cache) Set(key string, data string)

Set is a thread-safe way to add new Items to the map

func (*Cache) SetWithTtl

func (cache *Cache) SetWithTtl(key string, data string, duration time.Duration)

Set is a thread-safe way to add new Items to the map

func (*Cache) ToStringMap

func (cache *Cache) ToStringMap() map[string]string

ToStringMap @Description: convert to string map @receiver cache @return map[string]string

func (*Cache) ToValueArray

func (cache *Cache) ToValueArray() []string

ToValueArray @Description: convert values to array @receiver cache @return []string

type Item

type Item struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

MapItem represents a record in the cache map