diff options
Diffstat (limited to 'lib/stdlib/doc/src/gen_event.xml')
| -rw-r--r-- | lib/stdlib/doc/src/gen_event.xml | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/lib/stdlib/doc/src/gen_event.xml b/lib/stdlib/doc/src/gen_event.xml index 29a834a830..f9db5ba2a8 100644 --- a/lib/stdlib/doc/src/gen_event.xml +++ b/lib/stdlib/doc/src/gen_event.xml @@ -50,6 +50,7 @@ gen_event module Callback module ---------------- --------------- gen_event:start +gen_event:start_monitor gen_event:start_link -----> - gen_event:add_handler @@ -523,6 +524,40 @@ gen_event:stop -----> Module:terminate/2 </func> <func> + <name since="OTP @OTP-16120@">start_monitor() -> Result</name> + <name since="OTP @OTP-16120@">start_monitor(EventMgrName | Options) -> Result</name> + <name since="OTP @OTP-16120@">start_monitor(EventMgrName, Options) -> Result</name> + <fsummary>Create a stand-alone event manager process.</fsummary> + <type> + <v>EventMgrName = {local,Name} | {global,GlobalName} | {via,Module,ViaName}</v> + <v> Name = atom()</v> + <v> GlobalName = ViaName = term()</v> + <v>Options = [Option]</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> + <v>Result = {ok,{Pid,Mon}} | {error,{already_started,Pid}}</v> + <v> Pid = pid()</v> + </type> + <desc> + <p>Creates a stand-alone event manager process, that is, an event + manager that is not part of a supervision tree (and thus has + no supervisor) and atomically sets up a monitor to + the newly created process.</p> + <p>For a description of the arguments and return values, see + <seealso marker="#start_link/0"><c>start_link/0,1</c></seealso>. + Note that the return value on successful start differs from + <c>start_link/3,4</c>. <c>start_monitor/3,4</c> will return + <c>{ok,{Pid,Mon}}</c> where <c>Pid</c> is the process identifier + of the process, and <c>Mon</c> is a reference to the monitor + set up to monitor the process. If the start is not successful, + the caller will be blocked until the <c>DOWN</c> message has + been received and removed from the message queue.</p> + </desc> + </func> + + <func> <name since="">stop(EventMgrRef) -> ok</name> <name since="OTP 18.0">stop(EventMgrRef, Reason, Timeout) -> ok</name> <fsummary>Terminate a generic event manager.</fsummary> |