/doc/core/z_supervisor_named.html
HTML | 130 lines | 108 code | 22 blank | 0 comment | 0 complexity | c3bc0dbd3bb4e1664c2d5fda5794ded5 MD5 | raw file
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html> 3<head> 4<title>Module z_supervisor_named</title> 5<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc"> 6</head> 7<body bgcolor="white"> 8<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div> 9<hr> 10 11<h1>Module z_supervisor_named</h1> 12<ul class="index"><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>One for one supervisor to hold named worker processes, for use by modules and session management. 13 14<p><b>Behaviours:</b> <a href="gen_server.html"><tt>gen_server</tt></a>.</p> 15<p><b>Authors:</b> Marc Worrell (<a href="mailto:marc@worrell.nl"><tt>marc@worrell.nl</tt></a>).</p> 16 17<h2><a name="description">Description</a></h2>One for one supervisor to hold named worker processes, for use by modules and session management. 18 Adapted from supervisor.erl 19<h2><a name="index">Function Index</a></h2> 20<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#code_change-3">code_change/3</a></td><td></td></tr> 21<tr><td valign="top"><a href="#count_children-1">count_children/1</a></td><td></td></tr> 22<tr><td valign="top"><a href="#delete_child-2">delete_child/2</a></td><td></td></tr> 23<tr><td valign="top"><a href="#ensure_child-3">ensure_child/3</a></td><td></td></tr> 24<tr><td valign="top"><a href="#handle_call-3">handle_call/3</a></td><td></td></tr> 25<tr><td valign="top"><a href="#handle_cast-2">handle_cast/2</a></td><td></td></tr> 26<tr><td valign="top"><a href="#handle_info-2">handle_info/2</a></td><td></td></tr> 27<tr><td valign="top"><a href="#init-1">init/1</a></td><td></td></tr> 28<tr><td valign="top"><a href="#restart_child-2">restart_child/2</a></td><td></td></tr> 29<tr><td valign="top"><a href="#running_children-1">running_children/1</a></td><td></td></tr> 30<tr><td valign="top"><a href="#start_child-2">start_child/2</a></td><td></td></tr> 31<tr><td valign="top"><a href="#start_child-3">start_child/3</a></td><td></td></tr> 32<tr><td valign="top"><a href="#start_link-0">start_link/0</a></td><td>Start a new supervisor.</td></tr> 33<tr><td valign="top"><a href="#terminate-2">terminate/2</a></td><td></td></tr> 34<tr><td valign="top"><a href="#terminate_child-2">terminate_child/2</a></td><td></td></tr> 35<tr><td valign="top"><a href="#whereis-2">whereis/2</a></td><td></td></tr> 36<tr><td valign="top"><a href="#which_children-1">which_children/1</a></td><td></td></tr> 37</table> 38 39<h2><a name="functions">Function Details</a></h2> 40 41<h3 class="function"><a name="code_change-3">code_change/3</a></h3> 42<div class="spec"> 43<p><tt>code_change(OldVsn, State, Extra) -> any()</tt></p> 44</div> 45 46<h3 class="function"><a name="count_children-1">count_children/1</a></h3> 47<div class="spec"> 48<p><tt>count_children(SupRef) -> any()</tt></p> 49</div> 50 51<h3 class="function"><a name="delete_child-2">delete_child/2</a></h3> 52<div class="spec"> 53<p><tt>delete_child(SupRef, ChildRef) -> any()</tt></p> 54</div> 55 56<h3 class="function"><a name="ensure_child-3">ensure_child/3</a></h3> 57<div class="spec"> 58<p><tt>ensure_child(SupRef, ChildRef, MFA) -> any()</tt></p> 59</div> 60 61<h3 class="function"><a name="handle_call-3">handle_call/3</a></h3> 62<div class="spec"> 63<p><tt>handle_call(X1, From, State) -> any()</tt></p> 64</div> 65 66<h3 class="function"><a name="handle_cast-2">handle_cast/2</a></h3> 67<div class="spec"> 68<p><tt>handle_cast(X1, State) -> any()</tt></p> 69</div> 70 71<h3 class="function"><a name="handle_info-2">handle_info/2</a></h3> 72<div class="spec"> 73<p><tt>handle_info(Msg, State) -> any()</tt></p> 74</div> 75 76<h3 class="function"><a name="init-1">init/1</a></h3> 77<div class="spec"> 78<p><tt>init(Args) -> any()</tt></p> 79</div> 80 81<h3 class="function"><a name="restart_child-2">restart_child/2</a></h3> 82<div class="spec"> 83<p><tt>restart_child(SupRef, ChildRef) -> any()</tt></p> 84</div> 85 86<h3 class="function"><a name="running_children-1">running_children/1</a></h3> 87<div class="spec"> 88<p><tt>running_children(SupRef) -> any()</tt></p> 89</div> 90 91<h3 class="function"><a name="start_child-2">start_child/2</a></h3> 92<div class="spec"> 93<p><tt>start_child(SupRef, ChildSpecOrPid) -> any()</tt></p> 94</div> 95 96<h3 class="function"><a name="start_child-3">start_child/3</a></h3> 97<div class="spec"> 98<p><tt>start_child(SupRef, ChildName, Pid) -> any()</tt></p> 99</div> 100 101<h3 class="function"><a name="start_link-0">start_link/0</a></h3> 102<div class="spec"> 103<p><tt>start_link() -> any()</tt></p> 104</div><p>Start a new supervisor</p> 105 106<h3 class="function"><a name="terminate-2">terminate/2</a></h3> 107<div class="spec"> 108<p><tt>terminate(Reason, State) -> any()</tt></p> 109</div> 110 111<h3 class="function"><a name="terminate_child-2">terminate_child/2</a></h3> 112<div class="spec"> 113<p><tt>terminate_child(SupRef, ChildRef) -> any()</tt></p> 114</div> 115 116<h3 class="function"><a name="whereis-2">whereis/2</a></h3> 117<div class="spec"> 118<p><tt>whereis(SupRef, ChildRef) -> any()</tt></p> 119</div> 120 121<h3 class="function"><a name="which_children-1">which_children/1</a></h3> 122<div class="spec"> 123<p><tt>which_children(SupRef) -> any()</tt></p> 124</div> 125<hr> 126 127<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div> 128<p><i>Generated by EDoc, Aug 12 2011, 20:01:39.</i></p> 129</body> 130</html>