[GitHub] [couchdb] jaydoane commented on a change in pull request #2331: Expiring cache

[GitBox <gi...@apache.org>]

jaydoane commented on a change in pull request #2331: Expiring cache
URL: https://github.com/apache/couchdb/pull/2331#discussion_r352371090
 
 

 ##########
 File path: src/couch_expiring_cache/README.md
 ##########
 @@ -0,0 +1,20 @@
+# Couch Expiring Cache
+
+Key value cache with entries which are automatically deleted after
+they expire.
+
+This is a description of some of the modules:
+
+* `couch_expiring_cache`: The API module, it contains functions for
+  inserting and looking up cache entries, which are simply
+  pass-throughs to `couch_expiring_cache_fdb`.
+
+* `couch_expiring_cache_fdb`: The module which interacts with FDB, in
+  addition to insertion and lookup functions, it also contains a
+  function to clear an expired range.
+
+* `couch_expiring_cache_server`: A gen_server, this module
+  periodically removes expired cache entries using configurable
+  parameters for period, jitter, and batch size. It also fetches the
+  layer prefix on startup, and caches it in an ets table for
+  performance.
 
 Review comment:
   Good call! I pushed a commit to improve the README.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services