cache/README.md

Segmented in-memory cache

Inspiration

Cache uses N disposable ETS tables instead of single one. The cache applies eviction and quota policies at segment level. The oldest ETS table is destroyed and new one is created when quota or TTL criteria are exceeded. This approach outperforms the traditional timestamp indexing techniques.

The write operation always uses youngest segment. The read operation lookup key from youngest to oldest table until it is found same time key is moved to youngest segment to prolong TTL. If none of ETS table contains key then cache-miss occurs.

The downside is inability to assign precise TTL per single cache entry. TTL is always approximated to nearest segment. (e.g. cache with 60 sec TTL and 10 segments has 6 sec accuracy on TTL)

Getting started

The latest version of the library is available at its master branch. All development, including new features and bug fixes, take place on the master branch using forking and pull requests as described in contribution guidelines.

Installation

If you are using rebar3 you can include the library in your project with

{deps, [
   cache
]}.

Usage

The library exposes public interface through exports of cache.erl module.

Build library and run the development console to evaluate Key features

make && make run

Key features

key/value interface

The library implements traditional key/value interface through put, get and remove notation.

   application:start(cache).
   {ok, _} = cache:start_link(my_cache, [{n, 10}, {ttl, 60}]).
   
   ok  = cache:put(my_cache, <<"my key">>, <<"my value">>).
   Val = cache:get(my_cache, <<"my key">>).

asynchronous i/o

The library implements synchronous and asynchronous implementation of same functions. The asynchronous variant of function is annotated with _ suffix. E.g. get(...) is a synchronous cache lookup operation (the process is blocked until cache returns); get_(...) is an asynchronous variant that delivers result of execution to mailbox of the process.

   application:start(cache).
   {ok, _} = cache:start_link(my_cache, [{n, 10}, {ttl, 60}]).

   Ref = cache:get_(my_cache, <<"my key">>).
   receive {Ref, Val} -> Val end.

transform element

The library allows to apply an function over the cache element.

   application:start(cache).
   {ok, _} = cache:start_link(my_cache, [{n, 10}, {ttl, 60}]).

   cache:put(my_cache, <<"my key">>, <<"x">>).
   cache:apply(my_cache, <<"my key">>, fun(X) -> <<"x", X/binary>> end).
   cache:get(my_cache, <<"my key">>).

The library implement to helper functions to transform elements with append or prepend

   application:start(cache).
   {ok, _} = cache:start_link(my_cache, [{n, 10}, {ttl, 60}]).

   cache:put(my_cache, <<"my key">>, <<"b">>).
   cache:append(my_cache, <<"my key">>, <<"c">>).
   cache:prepend(my_cache, <<"my key">>, <<"a">>).
   cache:get(my_cache, <<"my key">>).

accumulator

   application:start(cache).
   {ok, _} = cache:start_link(my_cache, [{n, 10}, {ttl, 60}]).

   cache:acc(my_cache, <<"my key">>, 1).
   cache:acc(my_cache, <<"my key">>, 1).
   cache:acc(my_cache, <<"my key">>, 1).

check-and-store

The library implements the check-and-store semantic for put operations:

• add store key/val only if cache does not already hold data for this key
• replace store key/val only if cache does hold data for this key

configuration via Erlang sys.config

The cache instances are configurable via sys.config. Theses cache instances are supervised by application supervisor.

{cache, [
	{my_cache, [{n, 10}, {ttl, 60}]}
]}

distributed environment

The cache application uses standard Erlang distribution model. Please node that Erlang distribution uses single tcp/ip connection for message passing between nodes. Therefore, frequent read/write of large entries might impact on overall Erlang performance.

The global cache instance is visible to all Erlang nodes in the cluster.

   %% at a@example.com
   {ok, _} = cache:start_link({global, my_cache}, [{n, 10}, {ttl, 60}]).
   Val = cache:get({global, my_cache}, <<"my key">>).
   
   %% at b@example.com
   ok  = cache:put({global, my_cache}, <<"my key">>, <<"my value">>).
   Val = cache:get({global, my_cache}, <<"my key">>).

The local cache instance is accessible for any Erlang nodes in the cluster.

	%% a@example.com
   {ok, _} = cache:start_link(my_cache, [{n, 10}, {ttl, 60}]).
   Val = cache:get(my_cache, <<"my key">>).
   
   %% b@example.com
   ok  = cache:put({my_cache, 'a@example.com'}, <<"my key">>, <<"my value">>).
   Val = cache:get({my_cache, 'a@example.com'}, <<"my key">>).

How to Contribute

The library is Apache 2.0 licensed and accepts contributions via GitHub pull requests.

getting started

• Fork the repository on GitHub
• Read the README.md for build instructions
• Make pull request

commit message

The commit message helps us to write a good release note, speed-up review process. The message should address two question what changed and why. The project follows the template defined by chapter Contributing to a Project of Git book.

Short (50 chars or less) summary of changes

More detailed explanatory text, if necessary. Wrap it to about 72 characters or so. In some contexts, the first line is treated as the subject of an email and the rest of the text as the body. The blank line separating the summary from the body is critical (unless you omit the body entirely); tools like rebase can get confused if you run the two together.

Further paragraphs come after blank lines.

Bullet points are okay, too

Typically a hyphen or asterisk is used for the bullet, preceded by a single space, with blank lines in between, but conventions vary here

Bugs

If you detect a bug, please bring it to our attention via GitHub issues. Please make your report detailed and accurate so that we can identify and replicate the issues you experience:

• specify the configuration of your environment, including which operating system you're using and the versions of your runtime environments
• attach logs, screen shots and/or exceptions if possible
• briefly summarize the steps you took to resolve or reproduce the problem

Change log

• 2.0.0 - various changes on asynchronous api, not compatible with version 1.x
• 1.0.1 - production release

Contributors

• Jose Luis Navarro https://github.com/artefactop
• Valentin Micic

License

Copyright 2014 Dmitry Kolesnikov

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.