cache

Documentation

Index

• Variables
• func HasRegister(name MODE) bool
• func Register(name MODE, adapter Instance)
• type AddedFunc
• type Cache
  • func NewLFUPlugin(cb *Setting) Cache
  • func NewLRUPlugin(cb *Setting) Cache
  • func PluginInstance(cb *Setting) (adapter Cache)
• type EvictedFunc
• type Group
  • func (g *Group) Do(key interface{}, fn func() (interface{}, error), isWait bool) (interface{}, bool, error)
• type Instance
• type LFUPlugin
  • func (c *LFUPlugin) Get(key interface{}) (interface{}, error)
  • func (c *LFUPlugin) GetALL() map[interface{}]interface{}
  • func (c *LFUPlugin) GetIFPresent(key interface{}) (interface{}, error)
  • func (c *LFUPlugin) HasKey(key interface{}) bool
  • func (c *LFUPlugin) Keys() []interface{}
  • func (c *LFUPlugin) Len() int
  • func (c *LFUPlugin) Purge()
  • func (c *LFUPlugin) Remove(key interface{}) bool
  • func (c *LFUPlugin) Set(key, value interface{})
• type LRUPlugin
  • func (c *LRUPlugin) Get(key interface{}) (interface{}, error)
  • func (c *LRUPlugin) GetALL() map[interface{}]interface{}
  • func (c *LRUPlugin) GetIFPresent(key interface{}) (interface{}, error)
  • func (c *LRUPlugin) HasKey(key interface{}) bool
  • func (c *LRUPlugin) Keys() []interface{}
  • func (c *LRUPlugin) Len() int
  • func (c *LRUPlugin) Purge()
  • func (c *LRUPlugin) Remove(key interface{}) bool
  • func (c *LRUPlugin) Set(key, value interface{})
• type LoaderFunc
• type MODE
• type Options
• type Setting
  • func New(size int) *Setting
  • func (cb *Setting) AddedFunc(addedFunc AddedFunc) *Setting
  • func (cb *Setting) EvictType(tp MODE) *Setting
  • func (cb *Setting) EvictedFunc(evictedFunc EvictedFunc) *Setting
  • func (cb *Setting) Expiration(expiration time.Duration) *Setting
  • func (cb *Setting) LFU() *Setting
  • func (cb *Setting) LRU() *Setting
  • func (cb *Setting) LoaderFunc(loaderFunc LoaderFunc) *Setting
  • func (cb *Setting) Setting() Cache

Variables

var (
	ErrCacheSizeZero           = fmt.Errorf("Cache: Size <= 0")
	ErrCacheRegisterAdapterNil = fmt.Errorf("Cache: Register adapter is nil")
	ErrCacheCanNotFindAdapter  = fmt.Errorf("Cache: Can not find adapter: ")
	ErrCacheUnknownAdapter     = fmt.Errorf("Cache: unknown adapter: ")
	ErrCacheKeyNotFind         = fmt.Errorf("Cache: key not find")
)

Functions

func HasRegister

func HasRegister(name MODE) bool

func Register

func Register(name MODE, adapter Instance)

Types

type AddedFunc

type AddedFunc func(interface{}, interface{})

type Cache

type Cache interface {
	Set(interface{}, interface{})                  // set数据
	Get(interface{}) (interface{}, error)          // get数据
	GetIFPresent(interface{}) (interface{}, error) // 获取数据，如果数据不存在则通过cacheLoader获取数据，缓存并返回
	GetALL() map[interface{}]interface{}           // TODO：获得全量数据，业务慎用

	Remove(interface{}) bool // 删除key
	Purge()                  // 清除 plguin
	Keys() []interface{}     // 获得全部key
	Len() int                // 获得cache大小
	HasKey(interface{}) bool // 判断key是否存在
	// contains filtered or unexported methods
}

func NewLFUPlugin

func NewLFUPlugin(cb *Setting) Cache

NewLFUPlugin returns a new plugin.

func NewLRUPlugin

func NewLRUPlugin(cb *Setting) Cache

NewLRUPlugin returns a new plugin.

func PluginInstance

func PluginInstance(cb *Setting) (adapter Cache)

type EvictedFunc

type EvictedFunc func(interface{}, interface{})

type Group

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

func (*Group) Do

func (g *Group) Do(key interface{}, fn func() (interface{}, error), isWait bool) (interface{}, bool, error)

type Instance

type Instance func(*Setting) Cache

type LFUPlugin

type LFUPlugin struct {
	Options
	// contains filtered or unexported fields
}

Discards the least frequently used items first.

func (*LFUPlugin) Get

func (c *LFUPlugin) Get(key interface{}) (interface{}, error)

Get a value from cache pool using key if it exists. If it dose not exists key and has LoaderFunc, generate a value using `LoaderFunc` method returns value.

func (*LFUPlugin) GetALL

func (c *LFUPlugin) GetALL() map[interface{}]interface{}

Returns all key-value pairs in the cache.

func (*LFUPlugin) GetIFPresent

func (c *LFUPlugin) GetIFPresent(key interface{}) (interface{}, error)

Get a value from cache pool using key if it exists. If it dose not exists key, returns KeyNotFoundError. And send a request which refresh value for specified key if cache object has LoaderFunc.

func (*LFUPlugin) HasKey

func (c *LFUPlugin) HasKey(key interface{}) bool

func (*LFUPlugin) Keys

func (c *LFUPlugin) Keys() []interface{}

Returns a slice of the keys in the cache.

func (*LFUPlugin) Len

func (c *LFUPlugin) Len() int

Returns the number of items in the cache.

func (*LFUPlugin) Purge

func (c *LFUPlugin) Purge()

Completely clear the cache

func (*LFUPlugin) Remove

func (c *LFUPlugin) Remove(key interface{}) bool

Removes the provided key from the cache.

func (*LFUPlugin) Set

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

set a new key-value pair

type LRUPlugin

type LRUPlugin struct {
	Options
	// contains filtered or unexported fields
}

func (*LRUPlugin) Get

func (c *LRUPlugin) Get(key interface{}) (interface{}, error)

Get a value from cache pool using key if it exists. If it dose not exists key and has LoaderFunc, generate a value using `LoaderFunc` method returns value.

func (*LRUPlugin) GetALL

func (c *LRUPlugin) GetALL() map[interface{}]interface{}

Returns all key-value pairs in the cache.

func (*LRUPlugin) GetIFPresent

func (c *LRUPlugin) GetIFPresent(key interface{}) (interface{}, error)

func (*LRUPlugin) HasKey

func (c *LRUPlugin) HasKey(key interface{}) bool

func (*LRUPlugin) Keys

func (c *LRUPlugin) Keys() []interface{}

Returns a slice of the keys in the cache.

func (*LRUPlugin) Len

func (c *LRUPlugin) Len() int

Returns the number of items in the cache.

func (*LRUPlugin) Purge

func (c *LRUPlugin) Purge()

Completely clear the cache

func (*LRUPlugin) Remove

func (c *LRUPlugin) Remove(key interface{}) bool

Removes the provided key from the cache.

func (*LRUPlugin) Set

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

set a new key-value pair

type LoaderFunc

type LoaderFunc func(interface{}) (interface{}, error)

type MODE

type MODE string

const (
	LRU MODE = "lru" // Least Recently Used mode  最近最少使用
	LFU MODE = "lfu" // Least Frequently Used mode 最小频繁使用模式
)

type Options

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

type Setting

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

func New

func New(size int) *Setting

func (*Setting) AddedFunc

func (cb *Setting) AddedFunc(addedFunc AddedFunc) *Setting

func (*Setting) EvictType

func (cb *Setting) EvictType(tp MODE) *Setting

func (*Setting) EvictedFunc

func (cb *Setting) EvictedFunc(evictedFunc EvictedFunc) *Setting

func (*Setting) Expiration

func (cb *Setting) Expiration(expiration time.Duration) *Setting

func (*Setting) LFU

func (cb *Setting) LFU() *Setting

func (*Setting) LRU

func (cb *Setting) LRU() *Setting

func (*Setting) LoaderFunc

func (cb *Setting) LoaderFunc(loaderFunc LoaderFunc) *Setting

func (*Setting) Setting

func (cb *Setting) Setting() Cache