cachepp icon indicating copy to clipboard operation
cachepp copied to clipboard

Simple C++ Caching Framework

cachepp

can't think of a good pun

Overview

cachepp is a caching framework written in C++, designed for easy creation of caches with arbitrary eviction schemas and storing arbitrary data. The framework comes with several examples, a tutorial, interface api documentation, and automated correctness and performance testing. The goal is to provide a framework which is both robust enough to be used in a production library for developers, and flexible enough to be an experimental testbed for researchers and students.

Installation

git clone https://github.com/cripplet/cachepp.git
cd cachepp
git submodule update --init --recursive
make test # this will take a while

Updating

git pull
git submodule foreach --recursive git checkout master
git submodule foreach --recursive git pull

Documentation

Documentation is currently being added. The root directory for all documentation is at docs. The documentation index is found at docs/index.md

Quick Links

  • beginner's guide -- start here
  • applications -- a few examples of how to use cachepp in the real world
  • api -- a guide to the API
  • tutorial -- how to start a project, from creating the appropriate directory hierarchy to developing a cache to testing for correctness and performance

Contact

  • github
  • gmail
  • issues and feature requests should be directed to the project issues page