890bb18dbf
long-lived objects and won't clean them up. Oftentimes, the value returned
from a cache hit is short-lived. As a silly example:
func GetUser(http.responseWrite) {
user := cache.Get("user:1")
response.Write(serialize(user))
}
It's fine if the cache's GC cleans up "user:1" while the user variable has a reference to the
object..the cache's reference is removed and the real GC will clean it up
at some point after the user variable falls out of scope.
However, what if user is long-lived? Possibly stored as a reference to another
cached object? Normally (without this commit) the next time you call
cache.Get("user:1"), you'll get a miss and will need to refetch the object; even
though the original user object is still somewhere in memory - you just lost
your reference to it from the cache.
By enabling the Track() configuration flag, and calling TrackingGet() (instead
of Get), the cache will track that the object is in-use and won't GC it (even
if there's great memory pressure (what's the point? something else is holding on
to it anyways). Calling item.Release() will decrement the number of references.
When the count is 0, the item can be pruned from the cache.
The returned value is a TrackedItem which exposes:
- Value() interface{} (to get the actual cached value)
- Release() to release the item back in the cache
56 lines
920 B
Go
56 lines
920 B
Go
package ccache
|
|
|
|
import (
|
|
"container/list"
|
|
"sync"
|
|
"sync/atomic"
|
|
"time"
|
|
)
|
|
|
|
type TrackedItem interface {
|
|
Value() interface{}
|
|
Release()
|
|
}
|
|
|
|
type nilItem struct{}
|
|
|
|
func (n *nilItem) Value() interface{} { return nil }
|
|
func (n *nilItem) Release() {}
|
|
|
|
var NilTracked = new(nilItem)
|
|
|
|
type Item struct {
|
|
key string
|
|
sync.RWMutex
|
|
promotions int32
|
|
refCount int32
|
|
expires time.Time
|
|
value interface{}
|
|
element *list.Element
|
|
}
|
|
|
|
func newItem(key string, value interface{}, expires time.Time) *Item {
|
|
return &Item{
|
|
key: key,
|
|
value: value,
|
|
promotions: -1,
|
|
expires: expires,
|
|
}
|
|
}
|
|
|
|
func (i *Item) shouldPromote(getsPerPromote int32) bool {
|
|
return atomic.AddInt32(&i.promotions, 1) == getsPerPromote
|
|
}
|
|
|
|
func (i *Item) Value() interface{} {
|
|
return i.value
|
|
}
|
|
|
|
func (i *Item) track() {
|
|
atomic.AddInt32(&i.refCount, 1)
|
|
}
|
|
|
|
func (i *Item) Release() {
|
|
atomic.AddInt32(&i.refCount, -1)
|
|
}
|