flexflow v0.1.2

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

Process

Link to this section Summary

Types

result()

Init result

state()

Process state

t()

Functions

defnode(name, opts \\ [])
deftransition(module_or_name, tuple, opts \\ [])
init(p)
new(module, nodes, edges)
start(module, args \\ %{})

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 opaque

result()

View Source (opaque)

Specs

result()

Init result

Link to this opaque

state()

View Source (opaque)

Specs

state()

Process state

[:waiting, :initial, :active, :suspended, :terminated, :completed]

Link to this type

t()

View Source

Specs

t() :: %Flexflow.Process{
  args: map(),
  context: Flexflow.Context.t(),
  events: [Flexflow.Event.t()],
  graph: Graph.t(),
  id: Flexflow.id(),
  module: module(),
  name: Flexflow.name(),
  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

new(module, nodes, edges)

View Source

Specs

new(module(), Flexflow.nodes(), Flexflow.Transition.edge_map()) :: t()
Link to this function

start(module, args \\ %{})

View Source

Specs

start(module(), map()) :: result()

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