nova_cache (NOVA vv0.8.0)

nova_cache is a basic in-memory cache that uses ETS as backend. When a cache is initialized a process is spawned and associated for that particular cache. This process is kept alive through out the whole life time of the cache and is the owner of the ETS table that is used for storage.

The TTLs is implemented using erlang:send_after/4.

Link to this section Summary

Functions

delete(Cache, Key)

Deletes an entry in the cache.

flush(Cache)

Removes all entries for a cache.

get(Cache, Key)

Gets an entriy from the cache.

init_cache(Cachename)

Initializes a cache.

remove_cache(Cachename)

Removes the cache and frees up the memory.

set(Cache, Key, Value)

Same as set/4 but uses the default time for TTL which is defined as 3600000 (3600 seconds)

set(Cache, Key, Value, TTL)

Sets a cache value with a TTL. To refresh an entry one need to use the set-function again.

start_link(Cache)

Starts the server

Link to this section Functions

delete(Cache, Key)

Specs

delete(Cache :: atom(), Key :: term()) -> ok.

Deletes an entry in the cache.

flush(Cache)

Specs

flush(Cache :: atom()) -> ok.

Removes all entries for a cache.

get(Cache, Key)

Specs

get(Cache :: atom(), Key :: term()) -> {ok, Value :: any()} | {error, not_found}.

Gets an entriy from the cache.

init_cache(Cachename)

Specs

init_cache(Cachename :: atom()) ->
              {ok, Child} |
              {ok, Child, Info :: term()} |
              {error, {already_started, pid()} | {shutdown, term()} | term()}
              when Child :: undefined | pid().

Initializes a cache.

remove_cache(Cachename)

Specs

remove_cache(Cachename :: atom()) -> ok.

Removes the cache and frees up the memory.

set(Cache, Key, Value)

Specs

set(Cache :: atom(), Key :: term(), Value :: any()) -> ok.

Same as set/4 but uses the default time for TTL which is defined as 3600000 (3600 seconds)

set(Cache, Key, Value, TTL)

Specs

set(Cache :: atom(), Key :: term(), Value :: any(), TTL :: non_neg_integer()) -> ok.

Sets a cache value with a TTL. To refresh an entry one need to use the set-function again.

start_link(Cache)

Specs

start_link(Cache :: atom()) ->
              {ok, Pid :: pid()} |
              {error, Error :: {already_started, pid()}} |
              {error, Error :: term()} |
              ignore.

Starts the server