flexflow v0.2.0

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

Event

Link to this section Summary

Types

atom_result()
event_result()
key()
options()
t()

Functions

init(p)
key(map)
new(arg, states, process_tuple)
validate(events)

Callbacks

default_results()
graphviz_attribute()
handle_input(term, arg2, arg3)
handle_result(atom_result, arg2, term, arg4, arg5)
init(t, arg2)

Invoked after compile, return :ok if valid

is_event(term)
name()

Module name

validate(t, arg2)

Link to this section Types

Link to this type

atom_result()

View Source

Specs

atom_result() :: atom()
Link to this type

event_result()

View Source

Specs

event_result() :: {:ok, atom_result()} | {:error, term()}
Link to this type

key()

View Source

Specs

key() :: Flexflow.state_type_or_module() | String.t()
Link to this type

options()

View Source

Specs

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

t()

View Source

Specs

t() :: %Flexflow.Event{
  __op__: Flexflow.name(),
  __opts__: options(),
  context: Flexflow.Context.t(),
  from: Flexflow.state_key(),
  module: module(),
  name: Flexflow.name(),
  parent_module: module(),
  results: MapSet.t(atom_result()),
  to: Flexflow.state_key()
}

Link to this section Functions

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(), Flexflow.state_key()}
Link to this function

new(arg, states, process_tuple)

View Source

Specs

new(
  {key(), {key(), key()}, options()},
  [Flexflow.State.t()],
  Flexflow.Process.process_tuple()
) :: t()
Link to this function

validate(events)

View Source

Specs

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

Link to this section Callbacks

Link to this callback

default_results()

View Source

Specs

default_results() :: [atom_result()]
Link to this callback

graphviz_attribute()

View Source

Specs

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

handle_input(term, arg2, arg3)

View Source

Specs

handle_input(term(), Flexflow.State.t(), Flexflow.Process.t()) :: event_result()
Link to this callback

handle_result(atom_result, arg2, term, arg4, arg5)

View Source

Specs

handle_result(
  atom_result(),
  Flexflow.Process.event_type(),
  term(),
  Flexflow.State.t(),
  Flexflow.Process.t()
) :: Flexflow.Process.event_result()
Link to this callback

init(t, arg2)

View Source

Specs

init(t(), Flexflow.Process.t()) :: Flexflow.Process.result()

Invoked after compile, return :ok if valid

Link to this callback

is_event(term)

View Source

Specs

is_event(term()) :: boolean()
Link to this callback

name()

View Source

Specs

name() :: Flexflow.name()

Module name

Link to this callback

validate(t, arg2)

View Source

Specs

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