Syntropy.LatticeSupervisor (syntropy v0.2.0)

DynamicSupervisor-backed lattice container.

Summary

child_spec(arg)

Returns a specification to start this module under a supervisor.

list_agents()

Terminates a locally supervised agent and clears its retained knowledge.

@spec add_agent(String.t(), String.t(), keyword()) ::
  {:ok, String.t()} | {:error, term()}

@spec apply_persistent_join(String.t(), String.t()) ::
  {:ok, String.t()} | {:error, term()}

@spec apply_persistent_meet(String.t(), String.t()) ::
  {:ok, String.t()} | {:error, term()}

Returns a specification to start this module under a supervisor.

@spec get_agent(String.t()) :: Syntropy.Agent.state() | nil

@spec join(String.t(), String.t()) :: {:ok, String.t()} | {:error, term()}

@spec list_agents() :: [Syntropy.Agent.state()]

@spec meet(String.t(), String.t()) :: {:ok, String.t()} | {:error, term()}

@spec remove_agent(String.t()) :: :ok | {:error, :not_found}

Terminates a locally supervised agent and clears its retained knowledge.

Works for both permanent and temporary agents. Returns {:error, :not_found} when no agent with the given id is registered on this node.

@spec start_link(keyword()) :: Supervisor.on_start()