flexflow v0.2.0

Flexflow.State behaviour (flexflow v0.2.0) View Source

State

Link to this section Summary

Types

action_result()
options()
t()
type()

Functions

end?(state)
init(p)
key(map)
new(arg, process_tuple)
new_name(name, process_name)
normalize_state_key(arg, states, process_name)
start?(state)
validate(states)

Callbacks

graphviz_attribute()
handle_enter(t, arg2)
handle_event(arg1, term, t, arg4)
handle_leave(t, arg2)
init(t, arg2)
name()

Module name

type()
validate(t, arg2)

Invoked after compile, return :ok if valid

Link to this section Types

Link to this type

action_result()

View Source

Specs

action_result() :: :ok | {:ok, t()} | {:ok, term()} | {:error, term()}
Link to this type

options()

View Source

Specs

options() :: Keyword.t()
Link to this type

t()

View Source

Specs

t() :: %Flexflow.State{
  __in_edges__: [Flexflow.state_key()],
  __opts__: options(),
  __out_edges__: [Flexflow.state_key()],
  context: Flexflow.Context.t(),
  module: module(),
  name: Flexflow.name(),
  type: type()
}
Link to this type

type()

View Source

Specs

type() :: :bypass | :end | :start

Link to this section Functions

Link to this function

end?(state)

View Source

Specs

end?(t()) :: boolean()
Link to this function

init(p)

View Source

Specs

init(Flexflow.Process.t()) :: Flexflow.Process.result()
Link to this function

key(map)

View Source

Specs

key(t()) :: Flexflow.state_key()
Link to this function

new(arg, process_tuple)

View Source

Specs

new(
  {Flexflow.state_type_or_module(), options()},
  Flexflow.Process.process_tuple()
) :: t()
Link to this function

new_name(name, process_name)

View Source
Link to this function

normalize_state_key(arg, states, process_name)

View Source
Link to this function

start?(state)

View Source

Specs

start?(t()) :: boolean()
Link to this function

validate(states)

View Source

Specs

validate([t()]) :: [t()]

Link to this section Callbacks

Link to this callback

graphviz_attribute()

View Source

Specs

graphviz_attribute() :: keyword()
Link to this callback

handle_enter(t, arg2)

View Source

Specs

handle_enter(t(), Flexflow.Process.t()) :: Flexflow.Process.state_result()
Link to this callback

handle_event(arg1, term, t, arg4)

View Source

Specs

handle_event(Flexflow.Process.event_type(), term(), t(), Flexflow.Process.t()) ::
  Flexflow.Process.state_result()
Link to this callback

handle_leave(t, arg2)

View Source

Specs

handle_leave(t(), Flexflow.Process.t()) :: Flexflow.Process.state_result()
Link to this callback

init(t, arg2)

View Source

Specs

init(t(), Flexflow.Process.t()) :: Flexflow.Process.result()
Link to this callback

name()

View Source

Specs

name() :: Flexflow.name()

Module name

Link to this callback

type()

View Source

Specs

type() :: type()
Link to this callback

validate(t, arg2)

View Source

Specs

validate(t(), Flexflow.Process.t()) :: :ok

Invoked after compile, return :ok if valid