sm/cache
1
0
Fork 0
Code

Be clearer about the defaults, <80 width for the janitor comment, and remove 'default cleanup interval' -- there can be only one

Browse Source
This commit is contained in:
Patrick Mylund Nielsen 2012-06-22 03:50:10 +01:00
parent 8495026156
commit aa7f52c169
2 changed files with 15 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README
View File

@ -92,11 +92,11 @@ foo.Println(foo.Num)
== Reference
func New(de, ci time.Duration) *Cache
Returns a new cache with a given default expiration duration and default
cleanup interval. If the expiration duration is less than 1, the items in
the cache never expire and must be deleted manually. If the cleanup interval
is less than one, expired items are not deleted from the cache before their
next lookup or before calling DeleteExpired.
Returns a new cache with a given default expiration duration and cleanup
interval. If the expiration duration is less than 1, the items in the cache
never expire (by default), and must be deleted manually. If the cleanup
interval is less than one, expired items are not deleted from the cache
before their next lookup or before calling DeleteExpired.
func (c *Cache) Set(k string, x interface{}, d time.Duration)
Adds an item to the cache, replacing any existing item. If the duration is 0,

19
cache.go
View File

@ -284,11 +284,11 @@ func stopJanitor(c *Cache) {
c.janitor.Stop()
}
// Returns a new cache with a given default expiration duration and default cleanup
// interval. If the expiration duration is less than 1, the items in the cache never
// expire and must be deleted manually. If the cleanup interval is less than one,
// expired items are not deleted from the cache before their next lookup or before
// calling DeleteExpired.
// Returns a new cache with a given default expiration duration and cleanup
// interval. If the expiration duration is less than 1, the items in the cache
// never expire (by default), and must be deleted manually. If the cleanup
// interval is less than one, expired items are not deleted from the cache
// before their next lookup or before calling DeleteExpired.
func New(de, ci time.Duration) *Cache {
if de == 0 {
de = -1
@ -305,10 +305,11 @@ func New(de, ci time.Duration) *Cache {
c.janitor = j
go j.Run(c)
}
// This trick ensures that the janitor goroutine (which--granted it was enabled--is
// running DeleteExpired on c forever) does not keep the returned C object from being
// garbage collected. When it is garbage collected, the finalizer stops the janitor
// goroutine, after which c can be collected.
// This trick ensures that the janitor goroutine (which--granted it
// was enabled--is running DeleteExpired on c forever) does not keep
// the returned C object from being garbage collected. When it is
// garbage collected, the finalizer stops the janitor goroutine, after
// which c can be collected.
C := &Cache{c}
if ci > 0 {
runtime.SetFinalizer(C, stopJanitor)