hammer_backend_redis v6.1.2

View Source Hammer.Backend.Redis (hammer_backend_redis v6.1.2)

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 keys. This configuration is mandatory.
  • redix_config: Keyword list of options to the Redix redis client, also aliased to redis_config
  • redis_url: String url of redis server to connect to (optional, invokes Redix.start_link/2)

Link to this section Summary

Types

bucket_info()
bucket_key()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

count_hit(pid, key, now)

Record a hit in the bucket identified by key

count_hit(pid, key, now, increment)

Record a hit in the bucket identified by key, with a custom increment

delete_buckets(pid, id)

Delete all buckets associated with id.

get_bucket(pid, key)

Retrieve information about the bucket identified by key

start()
start(args)
start_link()
start_link(args)
stop()

Link to this section Types

Link to this type

bucket_info()

View Source 
@type bucket_info() ::
  {key :: bucket_key(), count :: integer(), created :: integer(),
   updated :: integer()}
Link to this type

bucket_key()

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

Link to this section Functions

Link to this function

child_spec(init_arg)

View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

count_hit(pid, key, now)

View Source

Record a hit in the bucket identified by key

Link to this function

count_hit(pid, key, now, increment)

View Source

Record a hit in the bucket identified by key, with a custom increment

Link to this function

delete_buckets(pid, id)

View Source

Delete all buckets associated with id.

Link to this function

get_bucket(pid, key)

View Source

Retrieve information about the bucket identified by key

Link to this function

start()

View Source 
@spec start() :: :ignore | {:error, any()} | {:ok, pid()}
Link to this function

start(args)

View Source 
@spec start(keyword()) :: :ignore | {:error, any()} | {:ok, pid()}
Link to this function

start_link()

View Source 
@spec start_link() :: :ignore | {:error, any()} | {:ok, pid()}
Link to this function

start_link(args)

View Source 
@spec start_link(keyword()) :: :ignore | {:error, any()} | {:ok, pid()}
Link to this function

stop()

View Source 
@spec stop() :: any()