Packages

hammer

3.0.0
7.4.0 7.3.0 7.2.0 7.1.0 7.0.1 7.0.0 7.0.0-rc.4 7.0.0-rc.3 7.0.0-rc.2 7.0.0-rc.1 7.0.0-rc.0 6.2.1 6.2.0 6.1.0 6.0.0 6.0.0-rc1 5.0.0 5.0.0-rc1 4.0.0 4.0.0-rc1 3.0.0 2.1.0 2.1.0-rc1 2.0.0 2.0.0-rc1 1.0.0 0.2.1 0.2.0 0.1.0

A rate-limiter with plugable backends.

HexDocs

Current section

Files

Jump to
Readme
29 Versions
0 Dependencies
Dependants
Files
Activity
hammer lib hammer backend.ex
Raw

lib/hammer/backend.ex 

defmodule Hammer.Backend do

  @moduledoc """

  The backend Behaviour module

  """



  @callback count_hit(key :: {bucket :: integer, id :: String.t()}, now :: integer) ::

              {:ok, count :: integer}

              | {:error, reason :: any}



  @callback get_bucket(key :: {bucket :: integer, id :: String.t()}) ::

              {:ok,

               {key :: {bucket :: integer, id :: String.t()}, count :: integer,

                created :: integer, updated :: integer}}

              | {:ok, nil}

              | {:error, reason :: any}



  @callback delete_buckets(id :: String.t()) ::

              {:ok, count_deleted :: integer}

              | {:error, reason :: any}

end