Packages

gust

0.1.33
0.1.37 0.1.36 0.1.35 0.1.34 0.1.33 0.1.32 0.1.31 0.1.30 0.1.29 0.1.28 0.1.27 0.1.26 0.1.25 0.1.24 0.1.23 0.1.22 0.1.21 0.1.20 0.1.19 0.1.18 0.1.17 0.1.16 0.1.15 0.1.14 0.1.13 0.1.12 0.1.11 0.1.10 0.1.9 0.1.8 0.1.7 0.1.6 0.1.5 0.1.4 0.1.2 0.1.1 0.1.0

A DAG-Based Workflow Orchestration Engine for Elixir

HexDocs

Current section

Files

Jump to
Readme
37 Versions
8 Dependencies
Dependants
Files
Activity
gust lib gust db_locker.ex
Raw

lib/gust/db_locker.ex 

defmodule Gust.DBLocker do

  @moduledoc """

  Behaviour for acquiring a DB-backed lock (e.g. Postgres advisory lock).



  Implementations must return `true` if the lock was acquired, `false` otherwise.

  """



  @typedoc "Lock identifier (e.g. integer key, string name, tuple, etc.)"

  @type lock_key :: term()



  @typedoc "Function to execute if the lock is acquired"

  @type attempt_result_fun :: (boolean() -> any())



  @callback try_lock(lock_key(), attempt_result_fun()) :: boolean()



  # coveralls-ignore-start

  @spec try_lock(lock_key(), attempt_result_fun()) :: boolean()

  def try_lock(lock_key, attempt_result) do

    impl().try_lock(lock_key, attempt_result)

  end



  defp impl, do: Application.get_env(:gust, :db_locker, Gust.DBLocker.Postgres)

  # coveralls-ignore-stop

end