Finitomata
Finitomata
v0.14.3

View Source Finitomata.Test.Auto (Finitomata v0.14.3)

The instance of FSM backed up by Finitomata.

fsm-representation

 FSM representation 

graph TD
    idle --> |start!| started
    started --> |do!| done

Link to this section Summary

Types

state()

Kind of event which might be send to initiate the transition.

Functions

__config__(key)

Getter for the internal compiled in FSM information.

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

config(key)

The convenient macro to allow using states in guards, returns a compile-time list of states for Finitomata.Test.Auto.

start_link(payload)

Starts an FSM alone with name and payload given.

Link to this section Types

Link to this type

state()

View Source 
@type state() :: :done | :started | :idle | :*

Kind of event which might be send to initiate the transition.

fsm-representation

 FSM representation 

graph TD
    idle --> |start!| started
    started --> |do!| done

Link to this section Functions

Link to this function

__config__(key)

View Source 
@spec __config__(atom()) :: any()

Getter for the internal compiled in FSM information.

Link to this function

child_spec(init_arg)

View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this macro

config(key)

View Source (macro)

The convenient macro to allow using states in guards, returns a compile-time list of states for Finitomata.Test.Auto.

Link to this function

start_link(payload)

View Source

Starts an FSM alone with name and payload given.

Usually one does not want to call this directly, the most common way would be to start a Finitomata supervision tree or even better embed it into the existing supervision tree and start FSM with Finitomata.start_fsm/3 passing Finitomata.Test.Auto as the first parameter.