Skip to content

Latest commit

 

History

History
90 lines (60 loc) · 3.34 KB

CHANGELOG.md

File metadata and controls

90 lines (60 loc) · 3.34 KB
Raw

v0.10.0

Improvements

  • add ConCache.size/1

v0.9.0

Fixes

  • Support for Elixir 1.1

v0.8.1

Fixes

  • Proper unlocking of an item. Previously it was possible that a process keeps the resource locked forever if the lock attempt timed out.

v0.8.0

Breaking changes

  • Removed following ConCache functions: size/1, memory/1, memory_bytes/1, get_all/1, with_existing/3
  • Changed ConCache update functions: update/3, dirty_update/3, update_existing/3 and dirty_update_existing/3. The provided lambda now must return either {:ok, new_value} or {:error, reason}.
  • Changed ConCache.try_isolated/4 - the function returns {:ok, result} or {:error, reason}
  • Upgraded to the most recent ExActor

Fixes

  • Fixed possible race-conditions on client process crash
  • Fixed mutual exclusion of independent caches

v0.6.0

  • Elixir v1.0.0

v0.5.1

  • bugfix: balanced lock wasn't working properly

v0.5.0

  • upgrade to Elixir v1.0.0-rc1

v0.4.0

  • upgrade to Elixir v0.15.0

v0.3.0

With this version, ConCache is turned into a proper application that obeys OTP principles. This required some changes to the way ConCache is used.

First, ConCache is now an OTP application. Consequently, you should add it as an application dependency in your mix.exs:

  ...

  def application do
    [applications: [:con_cache, ...], ...]
  end

  ...

This will make sure that before your app is started, ConCache required processes are started as well.

To create a cache, you can use ConCache.start_link/0,1,2 or ConCache.start/0,1,2. These functions now return result in the form of {:ok, pid} where pid identifies the owner process of the underlying ETS table. You can use that pid as the first argument to exported functions from ConCache module.

The first argument to both functions must contain ConCache options (unchanged), while the second argument contains GenServer start options. Both are by default empty lists.

The cache owner process is not inserted into the supervision tree of the ConCache OTP application. It is your responsibility to place it in your own tree at the desired place.

Of course, when using supervision, you can't use the ETS owner process pid to interface the cache, since this process can be restarted. Instead, you must rely on some registration facility. For example, this is how you can locally register the owner process, and use the alias to interface with the cache:

# Specifying the alias of the ETS owner process
iex(1)> ConCache.start_link([], name: :my_cache)

# Interfacing the cache via the registered alias
iex(2)> ConCache.put(:my_cache, :some_key, :some_value)
iex(3)> ConCache.get(:my_cache, :some_key)
:some_value

When creating the cache from the supervision tree, use something like this in your specification:

worker(ConCache, [con_cache_options, [name: ...]])

And then interface the cache via the corresponding alias.

Besides this simple local registration, you can also use {:global, some_alias}, and {:via, module, some_alias} format. For example, to register the process with gproc, you can do something like this:

ConCache.start_link([], name: {:via, :gproc, :my_cache})
...
ConCache.put({:via, :gproc, :my_cache}, :some_key, :some_value)