README
¶
cachedmap
A Go string keyed object cache with entry timeout and periodic flushing.
Cachedmap provides the equivalent of a cached map[string]interface{} store with per record timeouts.
Overall cache growth is managed by a periodic global flush of entire cache. For this reason it may be more suitable for applications where you expect a high hit rate but when a miss is not really so expensive. Or if you know that growth is not going to be a problem. In that case you could set the global flush period to some high value.
Usage example
cm := cachedmap.NewCachedMap(5*time.Second, 5*time.Minute, nil)
cm.Set("cake", &monkey)
...
m, ok := cm.Get("cake")
if ok {
freshMonkey = (m).(*monkeyType)
}
See the examples directory for more.
Alternatives
- https://github.com/muesli/cache2go is similar and provides more functionality
Documentation
¶
Index ¶
- type CacheEntry
- type CachedMap
- func (c *CachedMap) Get(key string) (interface{}, bool)
- func (c *CachedMap) GetStats() Stats
- func (c *CachedMap) Len() int
- func (c *CachedMap) Set(key string, data interface{}) time.Time
- func (c *CachedMap) SetLog(log *logrus.Entry)
- func (c *CachedMap) SetUntil(key string, data interface{}, removeTime time.Time)
- type Stats
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CacheEntry ¶
type CachedMap ¶
type CachedMap struct {
Name string
Hits int64
Misses int64
Writes int64
Flushes int64
MaxLength int
// contains filtered or unexported fields
}
func NewCachedMap ¶
func (*CachedMap) Get ¶
Get returns a non-expired entry and true. If no valid entry is found, it returns (nil, false).
func (*CachedMap) Set ¶
Set adds an item to the map with a computed remove time. It returns the remove time in case you want to use it in a nearby SetUntil() call.
Source Files
Directories