From 800265f49f912dcf66846b13aa8032bf2f380caf Mon Sep 17 00:00:00 2001
From: Raimo Niskanen
Date: Fri, 30 Sep 2016 11:17:22 +0200
Subject: Improve docs and types
---
lib/stdlib/doc/src/gen_statem.xml | 77 +++++++++++++++++++++++++++++++--------
1 file changed, 62 insertions(+), 15 deletions(-)
(limited to 'lib/stdlib/doc')
diff --git a/lib/stdlib/doc/src/gen_statem.xml b/lib/stdlib/doc/src/gen_statem.xml
index aa34f53d29..bba2de5e77 100644
--- a/lib/stdlib/doc/src/gen_statem.xml
+++ b/lib/stdlib/doc/src/gen_statem.xml
@@ -674,6 +674,9 @@ handle_event(_, _, State, Data) ->
they are merged with the current
That is: hibernate and timeout overrides
the current and reply sends a reply.
+ This has the same effect as if you would have appended
+ the actions from this state enter call to the actions
+ returned by the state function that changed states.
-
@@ -1002,28 +1005,42 @@ handle_event(_, _, State, Data) ->
-
+
- stop
+ keep_state
-
- Terminates the gen_statem by calling
- Module:terminate/3
- with Reason and
- NewData, if specified.
+ The gen_statem keeps the current state, or
+ does a state transition to the current state if you like,
+ sets NewData,
+ and executes all Actions.
+ This is the same as
+ {next_state,CurrentState,NewData,Actions}.
- stop_and_reply
+ keep_state_and_data
-
- Sends all Replies,
- then terminates the gen_statem by calling
- Module:terminate/3
- with Reason and
- NewData, if specified.
+ The gen_statem keeps the current state or
+ does a state transition to the current state if you like,
+ keeps the current server data,
+ and executes all Actions.
+ This is the same as
+ {next_state,CurrentState,CurrentData,Actions}.
+
+
+ All these terms are tuples or atoms and this property
+ will hold in any future version of gen_statem.
+
+
+
+
+
+
+
keep_state
-
@@ -1053,6 +1070,36 @@ handle_event(_, _, State, Data) ->
+
+
+
+
+ stop
+ -
+
+ Terminates the gen_statem by calling
+ Module:terminate/3
+ with Reason and
+ NewData, if specified.
+
+
+ stop_and_reply
+ -
+
+ Sends all Replies,
+ then terminates the gen_statem by calling
+ Module:terminate/3
+ with Reason and
+ NewData, if specified.
+
+
+
+
+ All these terms are tuples or atoms and this property
+ will hold in any future version of gen_statem.
+
+
+
@@ -1462,7 +1509,7 @@ handle_event(_, _, State, Data) ->
CallbackMode =
callback_mode() |
[ callback_mode()
- | state_entry_events ]
+ | state_enter() ]
@@ -1490,9 +1537,9 @@ handle_event(_, _, State, Data) ->
The CallbackMode is either just
- callback_mode()
+ callback_mode()
or a list containing
- callback_mode()
+ callback_mode()
and possibly the atom
state_enter.
--
cgit v1.2.3