flexflow v0.1.4

Flexflow.Process behaviour (flexflow v0.1.4) View Source

Process

Link to this section Summary

Types

identity()
result()

Init result

state()

Process state

t()

Functions

defnode(name, opts \\ [])
deftransition(module_or_name, tuple, opts \\ [])
init(p)
loop(p)
new(module, nodes, edge_list, identities)
next(p)
start(module, id, args \\ %{})
telemetry_invoke(arg, name, f)
to_dot(process)

Callbacks

init(arg1)

Invoked when process is started, after nodes and transitions init, see Elixir.Flexflow.Process.init/1

name()

Module name

Link to this section Types

Link to this type

identity()

View Source

Specs

identity() :: {:node | :transition, Flexflow.key_normalize()}
Link to this type

result()

View Source

Specs

result() :: {:ok, t()} | {:error, term()}

Init result

Link to this opaque

state()

View Source (opaque)

Specs

state()

Process state

[:created, :active, :loop]

Link to this type

t()

View Source

Specs

t() :: %Flexflow.Process{
  __attributes__: keyword(),
  __counter__: integer(),
  __identities__: [identity()],
  __loop_counter__: integer(),
  __path__: path(),
  args: Flexflow.process_args(),
  context: Flexflow.Context.t(),
  graph: Graph.t(),
  histories: [Flexflow.History.t()],
  id: Flexflow.id() | nil,
  module: module(),
  name: Flexflow.name() | nil,
  nodes: Flexflow.nodes(),
  opts: keyword(),
  state: state(),
  transitions: Flexflow.transitions()
}

Link to this section Functions

Link to this macro

defnode(name, opts \\ [])

View Source (macro)
Link to this macro

deftransition(module_or_name, tuple, opts \\ [])

View Source (macro)
Link to this function

init(p)

View Source

Specs

init(t()) :: result()
Link to this function

loop(p)

View Source

Specs

loop(t()) :: result()
Link to this function

new(module, nodes, edge_list, identities)

View Source

Specs

new(module(), [Flexflow.Node.t()], [Flexflow.Transition.edge_tuple()], [
  identity()
]) :: t()
Link to this function

next(p)

View Source

Specs

next(t()) :: result()
Link to this function

start(module, id, args \\ %{})

View Source

Specs

start(module(), Flexflow.id(), Flexflow.process_args()) :: result()
Link to this function

telemetry_invoke(arg, name, f)

View Source

Specs

telemetry_invoke(result(), atom(), (t() -> result())) :: result()
Link to this function

to_dot(process)

View Source

Link to this section Callbacks

Link to this callback

init(arg1)

View Source

Specs

init(t() | {:error, term()}) :: result()

Invoked when process is started, after nodes and transitions init, see Elixir.Flexflow.Process.init/1

Link to this callback

name()

View Source

Specs

name() :: Flexflow.name()

Module name