ttl

Documentation

Index

• type Cache
  • func NewCache(opts ...CacheOption) *Cache
  • func (c *Cache) Close()
  • func (c *Cache) Get(key interface{}) (interface{}, bool)
  • func (c *Cache) Len() int
  • func (c *Cache) Remove(key interface{})
  • func (c *Cache) Set(key, value interface{})
  • func (c *Cache) SetNX(key, value interface{}) bool
• type CacheOption
  • func CacheWithLRU(cap int) CacheOption
  • func CacheWithTTL(d time.Duration, refreshMode TTLRefreshMode) CacheOption
• type Counter
  • func NewCounter(d time.Duration) *Counter
  • func (c *Counter) Close()
  • func (c *Counter) Incr()
  • func (c *Counter) Len() int
  • func (c *Counter) Reset()
• type Item
• type TTLRefreshMode

Types

type Cache

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

Cache is a synchronised map of items that auto-expire once stale

func NewCache

func NewCache(opts ...CacheOption) *Cache

NewCache create a K-V cache

func (*Cache) Close

func (c *Cache) Close()

Close remove all data from Cache and exit cleanup. Cache cannot use any more after close

func (*Cache) Get

func (c *Cache) Get(key interface{}) (interface{}, bool)

Get is a thread-safe way to lookup items. Every lookup, also hence extending it's life if ttl is enabled

func (*Cache) Len

func (c *Cache) Len() int

Len returns the number of items in the cache

func (*Cache) Remove

func (c *Cache) Remove(key interface{})

Remove removes item from Cache

func (*Cache) Set

func (c *Cache) Set(key, value interface{})

Set is a thread-safe way to set item to the map

func (*Cache) SetNX

func (c *Cache) SetNX(key, value interface{}) bool

SetNX set value if the key is not exist

type CacheOption

type CacheOption func(*Cache)

func CacheWithLRU

func CacheWithLRU(cap int) CacheOption

func CacheWithTTL

func CacheWithTTL(d time.Duration, refreshMode TTLRefreshMode) CacheOption

type Counter

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

func NewCounter

func NewCounter(d time.Duration) *Counter

NewCounter create a counter with TTL records

func (*Counter) Close

func (c *Counter) Close()

Close remove all data from Counter and exit cleanup. Counter cannot be used any more after close

func (*Counter) Incr

func (c *Counter) Incr()

func (*Counter) Len

func (c *Counter) Len() int

func (*Counter) Reset

func (c *Counter) Reset()

type Item

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

type TTLRefreshMode

type TTLRefreshMode uint8

const (
	TTLRefreshModeGet TTLRefreshMode = 1 << iota
	TTLRefreshModeSet
	TTLRefreshModeNone TTLRefreshMode = 0
)