Jido.Signal.Journal.Persistence behaviour (Jido Signal v1.0.0)

View Source

Defines the behavior for Journal persistence adapters.

Summary

Types

conversation_id()

@type conversation_id() :: String.t()

error()

@type error() :: {:error, term()}

signal_id()

@type signal_id() :: String.t()

Callbacks

get_cause(signal_id, arg2)

@callback get_cause(signal_id(), pid() | nil) ::
  {:ok, signal_id()} | {:error, :not_found} | error()

get_conversation(conversation_id, arg2)

@callback get_conversation(conversation_id(), pid() | nil) :: {:ok, MapSet.t()} | error()

get_effects(signal_id, arg2)

@callback get_effects(signal_id(), pid() | nil) :: {:ok, MapSet.t()} | error()

get_signal(signal_id, arg2)

@callback get_signal(signal_id(), pid() | nil) ::
  {:ok, Jido.Signal.t()} | {:error, :not_found} | error()

init()

@callback init() :: :ok | {:ok, pid()} | error()

put_cause(signal_id, signal_id, arg3)

@callback put_cause(signal_id(), signal_id(), pid() | nil) :: :ok | error()

put_conversation(conversation_id, signal_id, arg3)

@callback put_conversation(conversation_id(), signal_id(), pid() | nil) :: :ok | error()

put_signal(t, arg2)

@callback put_signal(Jido.Signal.t(), pid() | nil) :: :ok | error()