expire check interval bluele#77

Author: dmotylev

README.md

@@ -312,6 +312,28 @@ added key: 1
 added key: 2
 ```
 
+## Interval
+### Expire check interval
+```go
+func main () {
+  gc := gcache.New(10).
+    LRU().
+    EvictedFunc(func(key, value interface{}) {
+        fmt.Printf("key: [%v] evicted\n", key)
+    }).
+    ExpireCheckInterval(300 * time.Millisecond).
+    Build()
+  
+  _ = gc.SetWithExpire(1, 1, time.Second)
+
+  time.Sleep(time.Second * 2)
+}
+```
+
+```
+key: [1] evicted
+```
+
 # Author
 
 **Jun Kimura**

arc.go

@@ -32,6 +32,31 @@ func (c *ARC) init() {
 	c.t2 = newARCList()
 	c.b1 = newARCList()
 	c.b2 = newARCList()
+
+	if c.expireCheckInterval != nil && *c.expireCheckInterval != 0 {
+		go func() {
+			for range time.Tick(*c.expireCheckInterval) {
+				for key := range c.items {
+					now := time.Now()
+					c.checkAndDeleteExpire(key, &now)
+				}
+			}
+		}()
+	}
+}
+
+func (c *ARC) checkAndDeleteExpire(key interface{}, now *time.Time) {
+	c.mu.Lock()
+	defer c.mu.Unlock()
+
+	item, ok := c.items[key]
+	if !ok {
+		return
+	}
+
+	if item.IsExpired(now) {
+		c.remove(key)
+	}
 }
 
 func (c *ARC) replace(key interface{}) {

cache.go

@@ -49,17 +49,18 @@ type Cache interface {
 }
 
 type baseCache struct {
-	clock            Clock
-	size             int
-	loaderExpireFunc LoaderExpireFunc
-	evictedFunc      EvictedFunc
-	purgeVisitorFunc PurgeVisitorFunc
-	addedFunc        AddedFunc
-	deserializeFunc  DeserializeFunc
-	serializeFunc    SerializeFunc
-	expiration       *time.Duration
-	mu               sync.RWMutex
-	loadGroup        Group
+	clock               Clock
+	size                int
+	loaderExpireFunc    LoaderExpireFunc
+	evictedFunc         EvictedFunc
+	purgeVisitorFunc    PurgeVisitorFunc
+	addedFunc           AddedFunc
+	deserializeFunc     DeserializeFunc
+	serializeFunc       SerializeFunc
+	expiration          *time.Duration
+	expireCheckInterval *time.Duration
+	mu                  sync.RWMutex
+	loadGroup           Group
 	*stats
 }
 
@@ -74,16 +75,17 @@ type (
 )
 
 type CacheBuilder struct {
-	clock            Clock
-	tp               string
-	size             int
-	loaderExpireFunc LoaderExpireFunc
-	evictedFunc      EvictedFunc
-	purgeVisitorFunc PurgeVisitorFunc
-	addedFunc        AddedFunc
-	expiration       *time.Duration
-	deserializeFunc  DeserializeFunc
-	serializeFunc    SerializeFunc
+	clock               Clock
+	tp                  string
+	size                int
+	loaderExpireFunc    LoaderExpireFunc
+	evictedFunc         EvictedFunc
+	purgeVisitorFunc    PurgeVisitorFunc
+	addedFunc           AddedFunc
+	expiration          *time.Duration
+	expireCheckInterval *time.Duration
+	deserializeFunc     DeserializeFunc
+	serializeFunc       SerializeFunc
 }
 
 func New(size int) *CacheBuilder {
@@ -168,6 +170,11 @@ func (cb *CacheBuilder) Expiration(expiration time.Duration) *CacheBuilder {
 	return cb
 }
 
+func (cb *CacheBuilder) ExpireCheckInterval(expireCheckInterval time.Duration) *CacheBuilder {
+	cb.expireCheckInterval = &expireCheckInterval
+	return cb
+}
+
 func (cb *CacheBuilder) Build() Cache {
 	if cb.size <= 0 && cb.tp != TYPE_SIMPLE {
 		panic("gcache: Cache size <= 0")
@@ -201,6 +208,7 @@ func buildCache(c *baseCache, cb *CacheBuilder) {
 	c.serializeFunc = cb.serializeFunc
 	c.evictedFunc = cb.evictedFunc
 	c.purgeVisitorFunc = cb.purgeVisitorFunc
+	c.expireCheckInterval = cb.expireCheckInterval
 	c.stats = &stats{}
 }
 

examples/autoloading/autoloading_cache.go

@@ -9,8 +9,8 @@ func main() {
 	gc := gcache.New(10).
 		LFU().
 		LoaderFunc(func(key interface{}) (interface{}, error) {
-		return fmt.Sprintf("%v-value", key), nil
-	}).
+			return fmt.Sprintf("%v-value", key), nil
+		}).
 		Build()
 
 	v, err := gc.Get("key")

examples/expireinterval/expire_interval.go

@@ -0,0 +1,21 @@
+package main
+
+import (
+	"fmt"
+	"github.com/bluele/gcache"
+	"time"
+)
+
+func main() {
+	gc := gcache.New(10).
+		LRU().
+		EvictedFunc(func(key, value interface{}) {
+			fmt.Printf("key: [%v] evicted\n", key)
+		}).
+		ExpireCheckInterval(300 * time.Millisecond).
+		Build()
+
+	_ = gc.SetWithExpire(1, 1, time.Second)
+
+	time.Sleep(time.Second * 2)
+}

lfu.go

@@ -43,6 +43,31 @@ func (c *LFUCache) init() {
 		freq:  0,
 		items: make(map[*lfuItem]struct{}),
 	})
+
+	if c.expireCheckInterval != nil && *c.expireCheckInterval != 0 {
+		go func() {
+			for range time.Tick(*c.expireCheckInterval) {
+				for key := range c.items {
+					now := time.Now()
+					c.checkAndDeleteExpire(key, &now)
+				}
+			}
+		}()
+	}
+}
+
+func (c *LFUCache) checkAndDeleteExpire(key interface{}, now *time.Time) {
+	c.mu.Lock()
+	defer c.mu.Unlock()
+
+	item, ok := c.items[key]
+	if !ok {
+		return
+	}
+
+	if item.IsExpired(now) {
+		c.remove(key)
+	}
 }
 
 // Set a new key-value pair

lru.go

@@ -24,6 +24,31 @@ func newLRUCache(cb *CacheBuilder) *LRUCache {
 func (c *LRUCache) init() {
 	c.evictList = list.New()
 	c.items = make(map[interface{}]*list.Element, c.size+1)
+
+	if c.expireCheckInterval != nil && *c.expireCheckInterval != 0 {
+		go func() {
+			for range time.Tick(*c.expireCheckInterval) {
+				for key := range c.items {
+					now := time.Now()
+					c.checkAndDeleteExpire(key, &now)
+				}
+			}
+		}()
+	}
+}
+
+func (c *LRUCache) checkAndDeleteExpire(key interface{}, now *time.Time) {
+	c.mu.Lock()
+	defer c.mu.Unlock()
+
+	item, ok := c.items[key]
+	if !ok {
+		return
+	}
+
+	if item.Value.(*lruItem).IsExpired(now) {
+		c.remove(key)
+	}
 }
 
 func (c *LRUCache) set(key, value interface{}) (interface{}, error) {

simple.go

@@ -25,6 +25,31 @@ func (c *SimpleCache) init() {
 	} else {
 		c.items = make(map[interface{}]*simpleItem, c.size)
 	}
+
+	if c.expireCheckInterval != nil && *c.expireCheckInterval != 0 {
+		go func() {
+			for range time.Tick(*c.expireCheckInterval) {
+				for key := range c.items {
+					now := time.Now()
+					c.checkAndDeleteExpire(key, &now)
+				}
+			}
+		}()
+	}
+}
+
+func (c *SimpleCache) checkAndDeleteExpire(key interface{}, now *time.Time) {
+	c.mu.Lock()
+	defer c.mu.Unlock()
+
+	item, ok := c.items[key]
+	if !ok {
+		return
+	}
+
+	if item.IsExpired(now) {
+		c.remove(key)
+	}
 }
 
 // Set a new key-value pair