diff options
| author | Anton N Ryabkov <[email protected]> | 2017-04-24 12:54:09 +0700 |
|---|---|---|
| committer | Anton N Ryabkov <[email protected]> | 2017-05-02 08:33:56 +0700 |
| commit | 063bebc88358f66cea17e3cf777b8b561a5f14c0 (patch) | |
| tree | 3e684e51db023d327e27079e0a7f3bb86d3bcbfc /lib/stdlib/doc/src/gen_statem.xml | |
| parent | 98233727217ddd8263253493a9248db79d3cd384 (diff) | |
| download | otp-063bebc88358f66cea17e3cf777b8b561a5f14c0.tar.gz otp-063bebc88358f66cea17e3cf777b8b561a5f14c0.tar.bz2 otp-063bebc88358f66cea17e3cf777b8b561a5f14c0.zip | |
Added support of auto_hibernate_timeout option for gen_statem.
Diffstat (limited to 'lib/stdlib/doc/src/gen_statem.xml')
| -rw-r--r-- | lib/stdlib/doc/src/gen_statem.xml | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/lib/stdlib/doc/src/gen_statem.xml b/lib/stdlib/doc/src/gen_statem.xml index 17a3a3c83c..9405868c78 100644 --- a/lib/stdlib/doc/src/gen_statem.xml +++ b/lib/stdlib/doc/src/gen_statem.xml @@ -453,6 +453,21 @@ handle_event(_, _, State, Data) -> </desc> </datatype> <datatype> + <name name="auto_hibernate_timeout_opt"/> + <desc> + <p> + auto_hibernate_timeout option that can be used when starting + a <c>gen_statem</c> server through, + <seealso marker="#enter_loop/4"><c>enter_loop/4-6</c></seealso>. + </p> + <p>If option<seealso marker="#type-auto_hibernate_timeout_opt"><c>{auto_hibernate_timeout,AutoHibernateTimeout}</c></seealso> is present, the <c>gen_statem</c> + process awaits any message for <c>AutoHibernateTimeout</c> milliseconds and + if no message is received, the process goes into hibernation automatically + (by calling <seealso marker="proc_lib#hibernate/3"><c>proc_lib:hibernate/3</c></seealso>). + </p> + </desc> + </datatype> + <datatype> <name name="start_opt"/> <desc> <p> @@ -1551,6 +1566,13 @@ handle_event(_, _, State, Data) -> </p> </item> <item> + <p>If option<seealso marker="#type-auto_hibernate_timeout_opt"><c>{auto_hibernate_timeout,AutoHibernateTimeout}</c></seealso> is present, the <c>gen_statem</c> + process awaits any message for <c>AutoHibernateTimeout</c> milliseconds and + if no message is received, the process goes into hibernation automatically + (by calling <seealso marker="proc_lib#hibernate/3"><c>proc_lib:hibernate/3</c></seealso>). + </p> + </item> + <item> <p> If option <seealso marker="#type-debug_opt"><c>{debug,Dbgs}</c></seealso> |