Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A caching library for Clojure implementing various cache strategies

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

clojure.core.cache

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.

  • Implementations of some basic caching strategies

    • First-in-first-out (FIFOCache)
    • Least-recently-used (LRUCache)
    • Least-used (LUCache -- sometimes called Least Frequently Used)
    • Time-to-live (TTLCache)
    • Naive cache (BasicCache)
    • Naive cache backed with soft references (SoftCache)
  • Implementation of an efficient buffer replacement policy based on the low inter-reference recency set algorithm (LIRSCache) described in the LIRS paper

  • 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.

Releases and Dependency Information

Latest stable release: 0.6.2

Leiningen dependency information:

[org.clojure/core.cache "0.6.2"]

Maven dependency information:

<dependency>
  <groupId>org.clojure</groupId>
  <artifactId>core.cache</artifactId>
  <version>0.6.2</version>
</dependency>

Example Usage

    (require '[clojure.core.cache :as cache])

    (def C (cache/fifo-cache-factory {:a 1, :b 2})

    (if (cache/has? C :c)
      (cache/hit C :c)
      (cache/miss C :c 42))

    ;=> {:a 1, :b 2, :c 42}

    (cache/evict C :b)

    ;=> {:a 1}

Refer to docstrings in the clojure.core.cache namespace, or the autogenerated API documentation for additional documentation

Developer Information

Change Log

  • Release 0.6.2 on 2012.08.07 more information
    • Removed reflection warnings
    • Fixed eviction of items from LU, TTL and LRU caches with thresholds less than two
    • Fixed eviction of items from FIFO cache prior to threshold
  • Release 0.6.2 on 2012.07.13 more information
    • Added SoftCache
    • Fixed eviction of items from LU and LRU caches prior to threshold
    • Adjusted default thresholds in factory functions
  • Release 0.5.0 on 2011.12.13 more information
    • Added evict
    • Added cache factory functions
    • Added associatve operation support

Copyright and License

Copyright (c) Rich Hickey, Michael Fogus and contributors, 2012. All rights reserved. The use and distribution terms for this software are covered by the Eclipse Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php) which can be found in the file epl-v10.html at the root of this distribution. By using this software in any fashion, you are agreeing to be bound bythe terms of this license. You must not remove this notice, or any other, from this software.

Something went wrong with that request. Please try again.