cache

Documentation

Index

• type Cache
  • func New(name string, expired time.Duration, update func(interface{}) (*Item, bool)) *Cache
  • func (c *Cache) LoadWithUpdate(key interface{}) (*Item, bool)
  • func (c *Cache) Name() string
  • func (c *Cache) Store(key interface{}, value *Item)
• type Item
  • func (i *Item) IsExpired() bool

Types

type Cache

type Cache struct {
	sync.Map

	C chan interface{}
	// contains filtered or unexported fields
}

Cache defines the methods LoadWithUpdate and Store, the user needs to define the function `update`.

func New

func New(name string, expired time.Duration, update func(interface{}) (*Item, bool)) *Cache

New returns the *Cache. the function update, if found new *Item, returns true, and stores it; else returns false, and delete the key from cache.

func (*Cache) LoadWithUpdate

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

LoadWithUpdate loads the cached item. if the item is not cached, it returns the newest and cache the new item. if the item is expired, it returns the cached item and try to cache the newest. if the item is not expired, it returns it and do nothing.

func (*Cache) Name

func (c *Cache) Name() string

Name returns the Cache object's name

func (*Cache) Store

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

Store caches the key and value, and updates its expired time.

type Item

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

Item contains the item be cached

func (*Item) IsExpired

func (i *Item) IsExpired() bool

IsExpired returns whether the item is expired