vieter-v
/
v
2
0
Fork 0
Code Issues Pull Requests Releases Activity

Make docs <100 chars wide

pull/13668/head
Mihai Galos 2022-03-06 17:31:18 +01:00
parent 13f9532985
commit f9fc2f641f
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
vlib/statemachine/README.md
View File

@ -1,12 +1,15 @@
# statemachine
This module implements a Finite State Machine (FSM), or State Machine in short.
The FSM is composed of states and transitions between them. These need to be specified by the client.
The FSM is composed of states and transitions between them.
These need to be specified by the client.
## Usage
Have a look at `statemachine_test.v` for usage examples.
On each `run()`, the possible transitions from the current state are evaluated. If the condition (specified by the client as a handler function) is true, then:
On each `run()`, the possible transitions from the current state are evaluated.
If the condition (specified by the client as a handler function) is true, then:
* the client-specifid `on_exit()` handler from the current state is called.
* the client-specifid `on_entry()` handler of the new state is called.
* the client-specifid `on_run()` handler of the new state is called.