View Source Hammer.Backend behaviour (hammer v6.2.1)

The backend Behaviour module.

Summary

Types

bucket_info()

bucket_key()

Callbacks

count_hit(pid, key, now)

count_hit(pid, key, now, increment)

delete_buckets(pid, id)

get_bucket(pid, key)

Types

bucket_info()

@type bucket_info() ::
  {key :: bucket_key(), count :: integer(), created :: integer(),
   updated :: integer()}

bucket_key()

@type bucket_key() :: {bucket :: integer(), id :: String.t()}

Callbacks

count_hit(pid, key, now)

@callback count_hit(
  pid :: pid(),
  key :: bucket_key(),
  now :: integer()
) :: {:ok, count :: integer()} | {:error, reason :: any()}

count_hit(pid, key, now, increment)

@callback count_hit(
  pid :: pid(),
  key :: bucket_key(),
  now :: integer(),
  increment :: integer()
) :: {:ok, count :: integer()} | {:error, reason :: any()}

delete_buckets(pid, id)

@callback delete_buckets(
  pid :: pid(),
  id :: String.t()
) :: {:ok, count_deleted :: integer()} | {:error, reason :: any()}

get_bucket(pid, key)

@callback get_bucket(
  pid :: pid(),
  key :: bucket_key()
) :: {:ok, info :: bucket_info()} | {:ok, nil} | {:error, reason :: any()}