hammer_backend_redis v4.0.3-rc1 Hammer.Backend.Redis View Source
Documentation for Hammer.Backend.Redis
This backend uses the Redix library to connect to Redis.
The backend process is started by calling start_link
:
Hammer.Backend.Redis.start_link(
expiry_ms: 60_000 * 10,
redix_config: [host: "example.com", port: 5050]
)
Options are:
expiry_ms
: Expiry time of buckets in milliseconds, used to set TTL on Redis keysredix_config
: Keyword list of options to theRedix
redis client, also aliased toredis_config
Link to this section Summary
Functions
Returns a specification to start this module under a supervisor
Record a hit in the bucket identified by key
Delete all buckets associated with id
Retrieve information about the bucket identified by key
Invoked when the server is started. start_link/3
or start/3
will
block until it returns
Link to this section Types
bucket_info() :: {key :: bucket_key, count :: integer, created :: integer, updated :: integer}
Link to this section Functions
Returns a specification to start this module under a supervisor.
See Supervisor
.
count_hit(pid :: pid, key :: bucket_key, now :: integer) :: {:ok, count :: integer} | {:error, reason :: any}
Record a hit in the bucket identified by key
delete_buckets(pid :: pid, id :: String.t) :: {:ok, count_deleted :: integer} | {:error, reason :: any}
Delete all buckets associated with id
.
get_bucket(pid :: pid, key :: bucket_key) :: {:ok, info :: bucket_info} | {:ok, nil} | {:error, reason :: any}
Retrieve information about the bucket identified by key
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
args
is the argument term (second argument) passed to start_link/3
.
Returning {:ok, state}
will cause start_link/3
to return
{:ok, pid}
and the process to enter its loop.
Returning {:ok, state, timeout}
is similar to {:ok, state}
except handle_info(:timeout, state)
will be called after timeout
milliseconds if no messages are received within the timeout.
Returning {:ok, state, :hibernate}
is similar to
{:ok, state}
except the process is hibernated before entering the loop. See
c:handle_call/3
for more information on hibernation.
Returning :ignore
will cause start_link/3
to return :ignore
and the
process will exit normally without entering the loop or calling c:terminate/2
.
If used when part of a supervision tree the parent supervisor will not fail
to start nor immediately try to restart the GenServer
. The remainder of the
supervision tree will be (re)started and so the GenServer
should not be
required by other processes. It can be started later with
Supervisor.restart_child/2
as the child specification is saved in the parent
supervisor. The main use cases for this are:
- The
GenServer
is disabled by configuration but might be enabled later. - An error occurred and it will be handled by a different mechanism than the
Supervisor
. Likely this approach involves callingSupervisor.restart_child/2
after a delay to attempt a restart.
Returning {:stop, reason}
will cause start_link/3
to return
{:error, reason}
and the process to exit with reason reason
without
entering the loop or calling c:terminate/2
.
Callback implementation for GenServer.init/1
.