From 063bebc88358f66cea17e3cf777b8b561a5f14c0 Mon Sep 17 00:00:00 2001
From: Anton N Ryabkov <anton.ryabkov@gmail.com>
Date: Mon, 24 Apr 2017 12:54:09 +0700
Subject: Added support of auto_hibernate_timeout option for gen_statem.

---
 lib/stdlib/doc/src/gen_statem.xml | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

(limited to 'lib/stdlib/doc/src')

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
@@ -452,6 +452,21 @@ handle_event(_, _, State, Data) ->
 	</p>
       </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>
@@ -1550,6 +1565,13 @@ handle_event(_, _, State, Data) ->
 	      <seealso marker="#type-start_ret"><c>{error,timeout}</c></seealso>.
             </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
-- 
cgit v1.2.3