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

Add README.md

pull/13668/head
Mihai Galos 2022-03-06 16:27:08 +01:00
parent c25e91f660
commit 13f9532985
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
vlib/statemachine/README.md 100644
View File

@ -0,0 +1,13 @@
# 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.
## 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:
* 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.