Documentation ¶
Index ¶
- Constants
- Variables
- type ARC
- func (c *ARC) Get(key interface{}) (interface{}, error)
- func (c *ARC) GetALL() map[interface{}]interface{}
- func (c *ARC) GetIFPresent(key interface{}) (interface{}, error)
- func (c *ARC) Keys() []interface{}
- func (c *ARC) Len() int
- func (c *ARC) Purge()
- func (c *ARC) Remove(key interface{}) bool
- func (c *ARC) Set(key, value interface{})
- type AddedFunc
- type Cache
- type CacheBuilder
- func (cb *CacheBuilder) ARC() *CacheBuilder
- func (cb *CacheBuilder) AddedFunc(addedFunc AddedFunc) *CacheBuilder
- func (cb *CacheBuilder) Build() Cache
- func (cb *CacheBuilder) EvictType(tp string) *CacheBuilder
- func (cb *CacheBuilder) EvictedFunc(evictedFunc EvictedFunc) *CacheBuilder
- func (cb *CacheBuilder) Expiration(expiration time.Duration) *CacheBuilder
- func (cb *CacheBuilder) LFU() *CacheBuilder
- func (cb *CacheBuilder) LRU() *CacheBuilder
- func (cb *CacheBuilder) LoaderFunc(loaderFunc LoaderFunc) *CacheBuilder
- func (cb *CacheBuilder) Simple() *CacheBuilder
- type EvictedFunc
- type Group
- type LFUCache
- func (c *LFUCache) Get(key interface{}) (interface{}, error)
- func (c *LFUCache) GetALL() map[interface{}]interface{}
- func (c *LFUCache) GetIFPresent(key interface{}) (interface{}, error)
- func (c *LFUCache) Keys() []interface{}
- func (c *LFUCache) Len() int
- func (c *LFUCache) Purge()
- func (c *LFUCache) Remove(key interface{}) bool
- func (c *LFUCache) Set(key, value interface{})
- type LRUCache
- func (c *LRUCache) Get(key interface{}) (interface{}, error)
- func (c *LRUCache) GetALL() map[interface{}]interface{}
- func (c *LRUCache) GetIFPresent(key interface{}) (interface{}, error)
- func (c *LRUCache) Keys() []interface{}
- func (c *LRUCache) Len() int
- func (c *LRUCache) Purge()
- func (c *LRUCache) Remove(key interface{}) bool
- func (c *LRUCache) Set(key, value interface{})
- type LoaderFunc
- type SimpleCache
- func (c *SimpleCache) Get(key interface{}) (interface{}, error)
- func (c *SimpleCache) GetALL() map[interface{}]interface{}
- func (c *SimpleCache) GetIFPresent(key interface{}) (interface{}, error)
- func (c *SimpleCache) Keys() []interface{}
- func (c *SimpleCache) Len() int
- func (c *SimpleCache) Purge()
- func (c *SimpleCache) Remove(key interface{}) bool
- func (c *SimpleCache) Set(key, value interface{})
Constants ¶
const ( TYPE_SIMPLE = "simple" TYPE_LRU = "lru" TYPE_LFU = "lfu" TYPE_ARC = "arc" )
Variables ¶
var KeyNotFoundError = errors.New("Key not found.")
Functions ¶
This section is empty.
Types ¶
type ARC ¶
type ARC struct {
// contains filtered or unexported fields
}
Constantly balances between LRU and LFU, to improve the combined result.
func (*ARC) Get ¶
Get a value from cache pool using key if it exists. If not exists and it has LoaderFunc, it will generate the value using you have specified LoaderFunc method returns value.
func (*ARC) GetALL ¶
func (c *ARC) GetALL() map[interface{}]interface{}
Returns all key-value pairs in the cache.
func (*ARC) GetIFPresent ¶
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 (*ARC) Keys ¶
func (c *ARC) Keys() []interface{}
Keys returns a slice of the keys in the cache.
type CacheBuilder ¶
type CacheBuilder struct {
// contains filtered or unexported fields
}
func New ¶
func New(size int) *CacheBuilder
func (*CacheBuilder) ARC ¶
func (cb *CacheBuilder) ARC() *CacheBuilder
func (*CacheBuilder) AddedFunc ¶
func (cb *CacheBuilder) AddedFunc(addedFunc AddedFunc) *CacheBuilder
func (*CacheBuilder) Build ¶
func (cb *CacheBuilder) Build() Cache
func (*CacheBuilder) EvictType ¶
func (cb *CacheBuilder) EvictType(tp string) *CacheBuilder
func (*CacheBuilder) EvictedFunc ¶
func (cb *CacheBuilder) EvictedFunc(evictedFunc EvictedFunc) *CacheBuilder
func (*CacheBuilder) Expiration ¶
func (cb *CacheBuilder) Expiration(expiration time.Duration) *CacheBuilder
func (*CacheBuilder) LFU ¶
func (cb *CacheBuilder) LFU() *CacheBuilder
func (*CacheBuilder) LRU ¶
func (cb *CacheBuilder) LRU() *CacheBuilder
func (*CacheBuilder) LoaderFunc ¶
func (cb *CacheBuilder) LoaderFunc(loaderFunc LoaderFunc) *CacheBuilder
Set a loader function. loaderFunc: create a new value with this function if cached value is expired.
func (*CacheBuilder) Simple ¶
func (cb *CacheBuilder) Simple() *CacheBuilder
type EvictedFunc ¶
type EvictedFunc func(interface{}, interface{})
type Group ¶
type Group struct {
// contains filtered or unexported fields
}
Group represents a class of work and forms a namespace in which units of work can be executed with duplicate suppression.
func (*Group) Do ¶
func (g *Group) Do(key interface{}, fn func() (interface{}, error), isWait bool) (interface{}, bool, error)
Do executes and returns the results of the given function, making sure that only one execution is in-flight for a given key at a time. If a duplicate comes in, the duplicate caller waits for the original to complete and receives the same results.
type LFUCache ¶
type LFUCache struct {
// contains filtered or unexported fields
}
Discards the least frequently used items first.
func (*LFUCache) Get ¶
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 (*LFUCache) GetALL ¶
func (c *LFUCache) GetALL() map[interface{}]interface{}
Returns all key-value pairs in the cache.
func (*LFUCache) GetIFPresent ¶
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 (*LFUCache) Keys ¶
func (c *LFUCache) Keys() []interface{}
Returns a slice of the keys in the cache.
type LRUCache ¶
type LRUCache struct {
// contains filtered or unexported fields
}
Discards the least recently used items first.
func (*LRUCache) Get ¶
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 (*LRUCache) GetALL ¶
func (c *LRUCache) GetALL() map[interface{}]interface{}
Returns all key-value pairs in the cache.
func (*LRUCache) GetIFPresent ¶
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 (*LRUCache) Keys ¶
func (c *LRUCache) Keys() []interface{}
Returns a slice of the keys in the cache.
type LoaderFunc ¶
type LoaderFunc func(interface{}) (interface{}, error)
type SimpleCache ¶
type SimpleCache struct {
// contains filtered or unexported fields
}
SimpleCache has no clear priority for evict cache. It depends on key-value map order.
func (*SimpleCache) Get ¶
func (c *SimpleCache) 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 (*SimpleCache) GetALL ¶
func (c *SimpleCache) GetALL() map[interface{}]interface{}
Returns all key-value pairs in the cache.
func (*SimpleCache) GetIFPresent ¶
func (c *SimpleCache) 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 (*SimpleCache) Keys ¶
func (c *SimpleCache) Keys() []interface{}
Returns a slice of the keys in the cache.
func (*SimpleCache) Remove ¶
func (c *SimpleCache) Remove(key interface{}) bool
Removes the provided key from the cache.
func (*SimpleCache) Set ¶
func (c *SimpleCache) Set(key, value interface{})
set a new key-value pair