API Reference flexflow v0.1.6

Usage

defmodule Review do
  use Flexflow.Process, version: 1

  defmodule Reviewing do
    use Flexflow.Event
  end

  defmodule Submit do
    use Flexflow.Transition
  end

  ## Start event
  event {Start, "draft"}
  ## End event
  event {End, "reviewed"}
  event {End, "canceled"}
  ## Intermediate event
  event "rejected"
  ## Custom event
  event Reviewing

  ## Define a transition
  ## `a ~> b` is a shortcut of `{a, b}`
  transition "modify1", "draft" ~> "draft"
  transition "cancel1", "draft" ~> "canceled"

  ## Custom transition
  transition Submit, "draft" ~> Reviewing

  transition "modify2", "rejected" ~> "rejected"
  transition "cancel2", "rejected" ~> "canceled"

  ## With custom name
  transition {Submit, "submit2"}, "rejected" ~> Reviewing

  transition "reject", Reviewing ~> "rejected"
  ## `async` mode means this transition run's in a separated elixir process.
  transition "agree", Reviewing ~> "reviewed", async: true
end

Default value:

• max_loop_limit: 1000
• telemetry_logger: true
• telemetry_logger_level: debug

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

Bypass

End

Start

History

Process

Examples

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

ProcessServer

Telemetry

Transition

Pass