Jido.Pod.Topology.Node (Jido v2.3.0)

Copy Markdown View Source

Canonical node definition for a pod topology.

V1 nodes are durable named collaborators managed through Jido.Agent.InstanceManager. The shape is intentionally small but future compatible with richer topology kinds.

Summary

Types

name()
t()

Functions

new(name, attrs)

Builds a validated topology node.

new!(name, attrs)

Builds a validated topology node, raising on error.

Types

name()

@type name() :: atom() | String.t()

t()

@type t() :: %Jido.Pod.Topology.Node{
  activation: atom(),
  initial_state: map(),
  kind: atom(),
  manager: atom(),
  meta: map(),
  module: atom(),
  name: atom() | binary()
}

Functions

new(name, attrs)

@spec new(name(), keyword() | map()) :: {:ok, t()} | {:error, term()}

Builds a validated topology node.

new!(name, attrs)

@spec new!(name(), keyword() | map()) :: t()

Builds a validated topology node, raising on error.