API Reference flexflow v0.2.0

Usage

defmodule Review do
  @vsn "1.0.1"
  use Flexflow.Process

  defmodule Reviewing do
    use Flexflow.State
  end

  defmodule Submit do
    use Flexflow.Event
  end

  ## Start state
  state {Start, :draft}
  state {End, :reviewed}
  state {End, :canceled}
  ## Bypass state
  state :rejected
  ## Custom state
  state Reviewing

  ## Define a event
  ## `a ~> b` is a shortcut of `{a, b}`
  event :modify1, :draft ~> :draft
  event :cancel1, :draft ~> :canceled, results: [:foo]

  ## Custom event
  event Submit, :draft ~> Reviewing

  event :modify2, :rejected ~> :rejected
  event :cancel2, :rejected ~> :canceled, results: [:foo]

  ## With custom name
  event {Submit, :submit2}, :rejected ~> Reviewing

  event :reject, Reviewing ~> :rejected
  event :agree, Reviewing ~> :reviewed, results: [:foo]
end

Default value:

• telemetry_default_handler: true

Context

• https://en.wikipedia.org/wiki/DOT_(graph_description_language)
• https://github.com/TLmaK0/gravizo
• https://gravizo.com/
• http://www.graphviz.org/doc/info/attrs.html

Event

EventDispatcher

Basic

https://erlang.org/doc/man/gen_statem.html#type-state_timeout

History

Process

YamlLoader

ProcessManager

ProcessParentManager

Examples

iex> defmodule DemoRegistry do
...>   use Elixir.Flexflow.ProcessRegistry
...> end
...> match?({:via, Registry, {Elixir.Flexflow.ProcessRegistry, {DemoRegistry, :abc}}}, DemoRegistry.via_tuple(:abc))
true

gen_statem

See Elixir.Flexflow.Process

State

Bypass

End

Start

Telemetry