View Source Reginald.Backends.PG.Locks (Reginald v0.0.2-rc.0.0.0)

Reginald.Backends.PG.Locks is a simplistic GenServer based locking mechanism.

Summary

Functions

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

lock(registry_name, lock_name, ref_or_pid)

View Source
@spec lock(
  registry_name :: atom() | pid(),
  lock_name :: term(),
  ref_or_pid :: reference() | pid()
) :: :acquired | :failed
Link to this function

lock_async(registry_name, lock_name, ref_or_pid)

View Source
@spec lock_async(
  registry_name :: atom() | pid(),
  lock_name :: term(),
  ref_or_pid :: reference() | pid()
) :: :acquired | :failed
@spec start_link(keyword()) :: GenServer.on_start()
Link to this function

unlock(registry_name, lock_name, ref_or_pid)

View Source
@spec unlock(
  registry_name :: atom() | pid(),
  lock_name :: term(),
  ref_or_pid :: reference() | pid()
) :: :ok