Solve.Lookup behaviour (Solve v0.2.1)

Process-local facade for interacting with a Solve app.

Summary

target()

Reads one direct {pid, message} event tuple from a lookup item.

Builds a direct {pid, message} event tuple with a fixed payload for a lookup item.

events(arg1)

@type target() :: Solve.controller_target()

(optional)

@callback handle_solve_updated(map(), term()) :: {:ok, term()}

@spec collection(atom()) :: Solve.Collection.t(map())

@spec collection(GenServer.server() | nil, atom()) :: Solve.Collection.t(map())

@spec dispatch(target(), atom()) :: :ok

@spec dispatch(target(), atom(), term()) :: :ok

@spec dispatch(GenServer.server() | nil, target(), atom(), term()) :: :ok

@spec event(map() | nil | Solve.Collection.t(any()), atom()) :: {pid(), term()} | nil

Reads one direct {pid, message} event tuple from a lookup item.

This is a convenience wrapper over events(controller)[event_name].

@spec event(map() | nil | Solve.Collection.t(any()), atom(), term()) ::
  {pid(), term()} | nil

Builds a direct {pid, message} event tuple with a fixed payload for a lookup item.

@spec events(map() | nil | Solve.Collection.t(any())) :: map() | nil

@spec handle_message(Solve.Message.t()) :: map()

@spec solve(target()) :: map() | nil

@spec solve(GenServer.server() | nil, target()) :: map() | nil