API Reference fsl v#0.2.0

Copy Markdown View Source

Modules

Declares a service building block: a reusable fragment of a flow, written in FSL, that other machines call.

Handle on a sub-FSM (child scenario) spawned from a parent scenario via the spawn_fsm macro of FSL.Machine.

The state a machine keeps about itself, and the macros a state body reads and writes it with.

What a renderer of FSL.Journal has to provide.

Renders an FSL.Journal run as a Mermaid sequence diagram.

Renders a run recorded by FSL.Journal as a PlantUML sequence diagram. The default renderer; FSL.Diagram.Mermaid is the alternative, and an application chooses with FSL.Host.diagram_renderer/0.

Issues HTTP requests from a machine, as events.

Connects FSL to the application it runs inside.

The host of a state machine that embeds no protocol: a plain %FSL.Context{}, nothing to start, no hooks.

Records one run, so that it can be drawn afterwards.

Finds the machine a caller asked for, by module name or by file path.

The Finite State Language: describes a process as a finite state machine, à la ExUnit.

A live registry of the machines currently running: one row each, updated as they move.

Execution engine for FSL.Machine finite state machines.

FSL.Valet turns any synchronous processing that takes time into an asynchronous one whose result is delivered as a single tagged message to the caller.