View Source ConfigCat.ConfigCache behaviour (ConfigCat v4.0.1)

Defines a configuration cache.

A calling application can optionally supply its own cache implementation to use in place of the default in-memory cache by providing the implementation's module name as the :cache option in ConfigCat.child_spec/1.

The provided implementation must explicitly or implicitly implement this behaviour.

If the cache implementation is a GenServer or similar, it is the calling application's responsibility to add it to its own supervision tree.

Summary

Types

key()

The cache key under which the configuration is stored

result()

The result of a cache fetch.

Callbacks

get(key)

Fetches the serialized configuration stored under the given cache key.

set(key, config)

Stores an updated serialized configuration under the given cache key.

Types

Link to this type

key()

View Source 
@type key() :: String.t()

The cache key under which the configuration is stored

Link to this type

result()

View Source 
@type result() :: {:ok, String.t()} | {:error, :not_found}

The result of a cache fetch.

Callbacks

Link to this callback

get(key)

View Source 
@callback get(key()) :: result()

Fetches the serialized configuration stored under the given cache key.

Returns {:ok, serialized_config} if there is a cached configuration or {:error, :not_found} if not.

Link to this callback

set(key, config)

View Source 
@callback set(key(), config :: String.t()) :: :ok | {:error, term()}

Stores an updated serialized configuration under the given cache key.

Returns :ok.