View Source Cloister.Monitor.Fsm (cloister v0.17.3)

The instance of FSM backed up by Finitomata.

FSM representation 

graph TD
    down --> |quorum!| assembling
    assembling --> |assembled| rehashing
    rehashing --> |nonode| nonode
    rehashing --> |rehash| rehashing
    rehashing --> |rehash| ready
    rehashing --> |stop!| stopping
    ready --> |nonode| nonode
    ready --> |rehash| ready
    ready --> |rehash| rehashing
    ready --> |stop!| stopping
    nonode --> |rehash!| assembling
    stopping --> |stop!| stopped

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 Cloister.Monitor.Fsm.

start_link(payload)

Starts an FSM alone with name and payload given.

Types

Link to this type

state()

View Source 
@type state() ::
  :stopped
  | :stopping
  | :ready
  | :nonode
  | :rehashing
  | :assembling
  | :down
  | :*

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

FSM representation 

graph TD
    down --> |quorum!| assembling
    assembling --> |assembled| rehashing
    rehashing --> |nonode| nonode
    rehashing --> |rehash| rehashing
    rehashing --> |rehash| ready
    rehashing --> |stop!| stopping
    ready --> |nonode| nonode
    ready --> |rehash| ready
    ready --> |rehash| rehashing
    ready --> |stop!| stopping
    nonode --> |rehash!| assembling
    stopping --> |stop!| stopped

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 Cloister.Monitor.Fsm.

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 Cloister.Monitor.Fsm as the first parameter.