diff options
| author | Ingela Andin <[email protected]> | 2017-05-15 11:50:26 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2017-05-15 11:50:26 +0200 |
| commit | 8baada6ba97f7809c99cae4e799fddb273a54882 (patch) | |
| tree | 423bf8c323b41dbd774d843b9dc4503cb9aead40 /lib/stdlib/doc/src/gen_event.xml | |
| parent | f1f81f0039466d203f66c4010fb94266bf8a7e9f (diff) | |
| parent | 90a84ea8bb70bf885a83d0aa4dfa598c7f45dc67 (diff) | |
| download | otp-8baada6ba97f7809c99cae4e799fddb273a54882.tar.gz otp-8baada6ba97f7809c99cae4e799fddb273a54882.tar.bz2 otp-8baada6ba97f7809c99cae4e799fddb273a54882.zip | |
Merge pull request #1407 from eltex-ecss/auto_hibernate_timeout
Add option hibernate_after to gen_server, gen_statem and gen_event.
Also added to the deprecated gen_fsm behaviour.
OTP14405
Diffstat (limited to 'lib/stdlib/doc/src/gen_event.xml')
| -rw-r--r-- | lib/stdlib/doc/src/gen_event.xml | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/lib/stdlib/doc/src/gen_event.xml b/lib/stdlib/doc/src/gen_event.xml index 09bde3e397..012737c390 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 <v> Name = atom()</v> <v> GlobalName = ViaName = term()</v> <v>Options = [Option]</v> - <v> Option = {debug,Dbgs} | {timeout,Time} | {spawn_opt,SOpts}</v> + <v> Option = {debug,Dbgs} | {timeout,Time} | {hibernate_after,HibernateAfterTimeout} | {spawn_opt,SOpts}</v> <v> Dbgs = [Dbg]</v> <v> Dbg = trace | log | statistics | {log_to_file,FileName} | {install,{Func,FuncState}}</v> <v> SOpts = [term()]</v> @@ -385,7 +385,7 @@ gen_event:stop -----> Module:terminate/2 <v> Name = atom()</v> <v> GlobalName = ViaName = term()</v> <v>Options = [Option]</v> - <v> Option = {debug,Dbgs} | {timeout,Time} | {spawn_opt,SOpts}</v> + <v> Option = {debug,Dbgs} | {timeout,Time} | {hibernate_after,HibernateAfterTimeout} | {spawn_opt,SOpts}</v> <v> Dbgs = [Dbg]</v> <v> Dbg = trace | log | statistics | {log_to_file,FileName} | {install,{Func,FuncState}}</v> <v> SOpts = [term()]</v> @@ -419,6 +419,12 @@ gen_event:stop -----> Module:terminate/2 <seealso marker="kernel:global"><c>global</c></seealso>. Thus, <c>{via,global,GlobalName}</c> is a valid reference.</p> </item> + <item> + <p>If option <c>{hibernate_after,HibernateAfterTimeout}</c> is present, the <c>gen_event</c> + process awaits any message for <c>HibernateAfterTimeout</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> </list> <p>If the event manager is successfully created, the function returns <c>{ok,Pid}</c>, where <c>Pid</c> is the pid of |