flexflow v0.1.8

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

Process

Link to this section Summary

Types

definition()
result()

Init result

state()
t()

Functions

a ~> b
after_init(p)
async(p, f, callback, value, opts \\ [])
event(key, opts \\ [])
gateway(key, tuple, opts \\ [])
handle_call(p, input, from \\ nil)
handle_cast(p, input)
handle_info(p, input)
init(p)
loop(p)
new(module, id, args \\ %{})
next(p)
terminate(p, reason)

Callbacks

handle_call(t, term, arg3)
handle_cast(t, term)
handle_info(t, term)
init(t)

Invoked when process is started, after events and gateways init, see Flexflow.Api.init/1

name()

Module name

terminate(t, term)

Link to this section Types

Link to this type

definition()

View Source

Specs

definition() :: {:event | :gateway, Flexflow.identity()}
Link to this type

result()

View Source

Specs

result() :: {:ok, t()} | {:error, term()}

Init result

Link to this type

state()

View Source

Specs

state() :: :paused | :waiting | :loop | :active | :created
Link to this type

t()

View Source

Specs

t() :: %Flexflow.Process{
  __args__: Flexflow.process_args(),
  __context__: Flexflow.Context.t(),
  __counter__: integer(),
  __definitions__: [definition()],
  __graphviz__: Keyword.t(),
  __loop__: integer(),
  __opts__: Keyword.t(),
  __tasks__: %{required(reference()) => term()},
  __vsn__: [{module(), term()}],
  events: %{required(Flexflow.identity()) => Flexflow.Event.t()},
  gateways: %{required(Flexflow.identity()) => Flexflow.Gateway.t()},
  id: Flexflow.id() | nil,
  module: module(),
  name: Flexflow.name(),
  state: state()
}

Link to this section Functions

Link to this function

a ~> b

View Source
Link to this function

after_init(p)

View Source

Specs

after_init(t()) :: result()
Link to this function

async(p, f, callback, value, opts \\ [])

View Source

Specs

async(t(), (() -> r), (arg, t(), :ok | :error, r -> result()), arg, Keyword.t()) ::
  t()
when arg: term(), r: term()
Link to this macro

event(key, opts \\ [])

View Source (macro)
Link to this macro

gateway(key, tuple, opts \\ [])

View Source (macro)
Link to this function

handle_call(p, input, from \\ nil)

View Source

Specs

handle_call(t(), term(), GenServer.from() | nil) :: result()
Link to this function

handle_cast(p, input)

View Source

Specs

handle_cast(t(), term()) :: result()
Link to this function

handle_info(p, input)

View Source

Specs

handle_info(t(), term()) :: result()
Link to this function

init(p)

View Source

Specs

init(t()) :: result()
Link to this function

loop(p)

View Source

Specs

loop(t()) :: result()
Link to this function

new(module, id, args \\ %{})

View Source

Specs

new(module(), Flexflow.id(), Flexflow.process_args()) :: result()
Link to this function

next(p)

View Source

Specs

next(t()) :: result()
Link to this function

terminate(p, reason)

View Source

Specs

terminate(t(), term()) :: term()

Link to this section Callbacks

Link to this callback

handle_call(t, term, arg3)

View Source (optional)

Specs

handle_call(t(), term(), GenServer.from()) :: result()
Link to this callback

handle_cast(t, term)

View Source (optional)

Specs

handle_cast(t(), term()) :: result()
Link to this callback

handle_info(t, term)

View Source (optional)

Specs

handle_info(t(), term()) :: result()
Link to this callback

init(t)

View Source

Specs

init(t()) :: result()

Invoked when process is started, after events and gateways init, see Flexflow.Api.init/1

Link to this callback

name()

View Source

Specs

name() :: Flexflow.name()

Module name

Link to this callback

terminate(t, term)

View Source (optional)

Specs

terminate(t(), term()) :: term()