Skip to content

Commit

Permalink
CCACHE-6: Release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
fogus committed Dec 13, 2011
1 parent 82478b1 commit f9ab382
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions docs/release-notes/release-0.5.0.txt
@@ -1,13 +1,56 @@
core.cache v0.5.0 Release Notes
===============================

core.cache is a new Clojure contrib library providing the following features:

* An underlying `CacheProtocol` used as the base abstraction for implementing new synchronous caches

* A `defcache` macro for hooking your `CacheProtocol` implementations into the Clojure associative data capabilities.

* Immutable implementations of some basic caching strategies
- First-in-first-out (FIFOCache)
- Least-recently-used (LRUCache)
- Least-used (LUCache)
- Time-to-live (TTLCache)
- Naive cache (BasicCache)

* Implementation of an efficient buffer replacement policy based on the *low inter-reference recency set* algorithm (LIRSCache)

* Factory functions for each existing cache type

core.cache is based on a library named Clache, found at http://github.com/fogus/clache that is planned for deprecation.

Places
------

* [Source code](https://github.com/clojure/core.cache)
* [Ticket system](http://dev.clojure.org/jira/browse/CCACHE)
* Examples and documentation -- in progress

Changes from Clache
-------------------

The v0.5.0 version of core.cache is based almost wholly on the final version of Clache, with the following changes:

* An addition of an `evict` function on the `CacheProtocol` used to explicitly remove a value from a cache based on a key. All of the existing cache types implement this function *except* for `LIRSCache`.

* The addition of cache factory functions for all of the existing cache types

* The associative structure behaviors are defined solely in terms of the underlying `CacheProtocol`

* The `SoftCache` implementation was buggy and removed for now

Plans
-----

The following capabilities are under design, development, or consideration for future versions of core.cache:

* Asynchronous caching protocol
* `LIRSCache evict`
* Removal of the `seed` function from the `CacheProtocol`
* Reimplementation of a cache based on soft references
* test.generative usage
* Deprecation of Clache
* Documentation and examples

More planning is needed around capabilities not listed nor thought of.

0 comments on commit f9ab382

Please sign in to comment.