Concord.Engine behaviour (Concord v3.0.1)

Storage engine boundary for Concord's public KV surface.

Concord uses Concord.Engine.VSR by default. Explicit APIs such as Concord.Local pass a different engine per call.

Summary

command()

query()

reason()

members(keyword)

status(keyword)

@type command() :: term()

@type query() :: term()

@type reason() :: term()

@callback command(
  command(),
  keyword()
) :: {:ok, term()} | {:error, reason()}

@callback members(keyword()) :: {:ok, list()} | {:error, reason()}

@callback query(
  query(),
  keyword()
) :: {:ok, term()} | {:error, reason()}

@callback status(keyword()) :: {:ok, map()} | {:error, reason()}

@spec command(
  command(),
  keyword()
) :: {:ok, term()} | {:error, reason()}

@spec members(keyword()) :: {:ok, list()} | {:error, reason()}

@spec query(
  query(),
  keyword()
) :: {:ok, term()} | {:error, reason()}

@spec status(keyword()) :: {:ok, map()} | {:error, reason()}