From 42faed747858483506c12e722573e48d0f5f7996 Mon Sep 17 00:00:00 2001
From: Anton N Ryabkov
Date: Wed, 12 Apr 2017 15:06:39 +0700
Subject: Added support of auto_hibernate_timeout option for gen_server,
gen_fsm, gen_event process's.
There is realized gen_server, gen_fsm, gen_event automatic hibernation functionality.
Added unit tests for realized functionality.
Added documentation for auto_hibernate_timeout option.
---
lib/stdlib/doc/src/gen_event.xml | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
(limited to 'lib/stdlib/doc/src/gen_event.xml')
diff --git a/lib/stdlib/doc/src/gen_event.xml b/lib/stdlib/doc/src/gen_event.xml
index 56cb7974a2..fbd6cf220a 100644
--- a/lib/stdlib/doc/src/gen_event.xml
+++ b/lib/stdlib/doc/src/gen_event.xml
@@ -358,7 +358,7 @@ gen_event:stop -----> Module:terminate/2
Name = atom()
GlobalName = ViaName = term()
Options = [Option]
- Option = {debug,Dbgs} | {timeout,Time} | {spawn_opt,SOpts}
+ Option = {debug,Dbgs} | {timeout,Time} | {auto_hibernate_timeout,AutoHibernateTimeout} | {spawn_opt,SOpts}
Dbgs = [Dbg]
Dbg = trace | log | statistics | {log_to_file,FileName} | {install,{Func,FuncState}}
SOpts = [term()]
@@ -385,7 +385,7 @@ gen_event:stop -----> Module:terminate/2
Name = atom()
GlobalName = ViaName = term()
Options = [Option]
- Option = {debug,Dbgs} | {timeout,Time} | {spawn_opt,SOpts}
+ Option = {debug,Dbgs} | {timeout,Time} | {auto_hibernate_timeout,AutoHibernateTimeout} | {spawn_opt,SOpts}
Dbgs = [Dbg]
Dbg = trace | log | statistics | {log_to_file,FileName} | {install,{Func,FuncState}}
SOpts = [term()]
@@ -419,6 +419,12 @@ gen_event:stop -----> Module:terminate/2
global.
Thus, {via,global,GlobalName} is a valid reference.
+ -
+
If option {auto_hibernate_timeout,AutoHibernateTimeout} is present, the gen_event
+ process wait any message AutoHibernateTimeout milliseconds and
+ in case of no message was received, process goes into hibernation automatically
+ (by calling proc_lib:hibernate/3).
+
If the event manager is successfully created, the function
returns {ok,Pid}, where Pid is the pid of
--
cgit v1.2.3