Browse files

Be clearer about the defaults, <80 width for the janitor comment, and…

… remove 'default cleanup interval' -- there can be only one
  • Loading branch information...
1 parent 8495026 commit aa7f52c16926d76a095e44e0fa4b4f8e2e1728e3 @patrickmn committed Jun 22, 2012
Showing with 15 additions and 14 deletions.
  1. +5 −5 README
  2. +10 −9 cache.go
View
10 README
@@ -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,
View
19 cache.go
@@ -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)

0 comments on commit aa7f52c

Please sign in to comment.