Current section
Files
Jump to
Current section
Files
doc/supool.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Module supool</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
<body bgcolor="white">
<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>
<hr>
<h1>Module supool</h1>
<ul class="index"><li><a href="#description">Description</a></li><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
<h3><a name="Supervisor_Pool">Supervisor Pool</a></h3>
Simple supervisor process pool with round-robin.
<p>Copyright © 2011-2018 Michael Truog</p>
<p><b>Version:</b> 1.7.4 Sep 15 2018 17:33:35
------------------------------------------------------------------------</p>
<p><b>Behaviours:</b> <a href="gen_server.html"><tt>gen_server</tt></a>.</p>
<p><b>Authors:</b> Michael Truog (<a href="mailto:mjtruog at protonmail dot com"><tt>mjtruog at protonmail dot com</tt></a>).</p>
<h2><a name="description">Description</a></h2>
<h3><a name="Supervisor_Pool">Supervisor Pool</a></h3>
Simple supervisor process pool with round-robin.
<h2><a name="types">Data Types</a></h2>
<h3 class="typedecl"><a name="type-child_spec">child_spec()</a></h3>
<p><tt>child_spec() = {Id::any(), StartFunc::{module(), atom(), list()}, Restart::permanent | transient | temporary, Shutdown::brutal_kill | pos_integer(), Type::worker | supervisor, Modules::[module()] | dynamic}</tt></p>
<h3 class="typedecl"><a name="type-options">options()</a></h3>
<p><tt>options() = [{max_r, non_neg_integer()} | {max_t, pos_integer()}]</tt></p>
<h2><a name="index">Function Index</a></h2>
<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>
<tr><td valign="top"><a href="#get-1">get/1</a></td><td>
<h4><a name="Get_a_pool_process.">Get a pool process.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#handle_call-3">handle_call/3</a></td><td></td></tr>
<tr><td valign="top"><a href="#handle_cast-2">handle_cast/2</a></td><td></td></tr>
<tr><td valign="top"><a href="#handle_info-2">handle_info/2</a></td><td></td></tr>
<tr><td valign="top"><a href="#init-1">init/1</a></td><td></td></tr>
<tr><td valign="top"><a href="#pool_worker_start_link-2">pool_worker_start_link/2</a></td><td></td></tr>
<tr><td valign="top"><a href="#start_link-3">start_link/3</a></td><td>
<h4><a name="Start_the_pool_supervisor.">Start the pool supervisor.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#start_link-4">start_link/4</a></td><td>
<h4><a name="Start_the_pool_supervisor_with_restart_options.">Start the pool supervisor with restart options.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#terminate-2">terminate/2</a></td><td></td></tr>
</table>
<h2><a name="functions">Function Details</a></h2>
<h3 class="function"><a name="code_change-3">code_change/3</a></h3>
<div class="spec">
<p><tt>code_change(X1, State, X3) -> any()</tt></p>
</div>
<h3 class="function"><a name="get-1">get/1</a></h3>
<div class="spec">
<p><tt>get(Name::atom()) -> pid() | undefined</tt><br></p>
</div><p>
<h4><a name="Get_a_pool_process.">Get a pool process.</a></h4>
</p>
<h3 class="function"><a name="handle_call-3">handle_call/3</a></h3>
<div class="spec">
<p><tt>handle_call(Request, X2, State) -> any()</tt></p>
</div>
<h3 class="function"><a name="handle_cast-2">handle_cast/2</a></h3>
<div class="spec">
<p><tt>handle_cast(Request, State) -> any()</tt></p>
</div>
<h3 class="function"><a name="handle_info-2">handle_info/2</a></h3>
<div class="spec">
<p><tt>handle_info(Request, State) -> any()</tt></p>
</div>
<h3 class="function"><a name="init-1">init/1</a></h3>
<div class="spec">
<p><tt>init(X1) -> any()</tt></p>
</div>
<h3 class="function"><a name="pool_worker_start_link-2">pool_worker_start_link/2</a></h3>
<div class="spec">
<p><tt>pool_worker_start_link(Name::atom(), Supervisor::pid()) -> {ok, pid()} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="start_link-3">start_link/3</a></h3>
<div class="spec">
<p><tt>start_link(Name::atom(), Count::pos_integer(), ChildSpec::<a href="#type-child_spec">child_spec()</a>) -> {ok, pid()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Start_the_pool_supervisor.">Start the pool supervisor.</a></h4>
</p>
<h3 class="function"><a name="start_link-4">start_link/4</a></h3>
<div class="spec">
<p><tt>start_link(Name::atom(), Count::pos_integer(), ChildSpec::<a href="#type-child_spec">child_spec()</a>, Options::<a href="#type-options">options()</a>) -> {ok, pid()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Start_the_pool_supervisor_with_restart_options.">Start the pool supervisor with restart options.</a></h4>
</p>
<h3 class="function"><a name="terminate-2">terminate/2</a></h3>
<div class="spec">
<p><tt>terminate(X1, X2) -> any()</tt></p>
</div>
<hr>
<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>
<p><i>Generated by EDoc</i></p>
</body>
</html>