Current section
Files
Jump to
Current section
Files
doc/varpool.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 varpool</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 varpool</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="Local_Variable_Pool">Local Variable Pool</a></h3>.
<p>Copyright © 2015-2017 Michael Truog</p>
<p><b>Version:</b> 1.7.1 May 31 2017 15:15:43
------------------------------------------------------------------------</p>
<p><b>Authors:</b> Michael Truog (<a href="mailto:mjtruog [at] gmail (dot) com"><tt>mjtruog [at] gmail (dot) com</tt></a>).</p>
<h2><a name="description">Description</a></h2>
<h3><a name="Local_Variable_Pool">Local Variable Pool</a></h3>
<h2><a name="types">Data Types</a></h2>
<h3 class="typedecl"><a name="type-group">group()</a></h3>
<p><tt>group() = {Group::any(), {M::module(), F::atom(), A::list()}, Options::[{shutdown, pos_integer()} | {count_hash, pos_integer()} | {count_random, pos_integer()} | {hash, {module(), atom()} | fun((any(), pos_integer()) -> non_neg_integer())} | {random, {module(), atom()} | fun((pos_integer()) -> non_neg_integer())}]}</tt></p>
<h3 class="typedecl"><a name="type-options">options()</a></h3>
<p><tt>options() = [{max_r, non_neg_integer()} | {max_t, pos_integer()} | {groups, [<a href="#type-group">group()</a>, ...]}, ...]</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="#destroy-1">destroy/1</a></td><td></td></tr>
<tr><td valign="top"><a href="#get-2">get/2</a></td><td></td></tr>
<tr><td valign="top"><a href="#get-3">get/3</a></td><td></td></tr>
<tr><td valign="top"><a href="#new-1">new/1</a></td><td></td></tr>
<tr><td valign="top"><a href="#update-2">update/2</a></td><td></td></tr>
</table>
<h2><a name="functions">Function Details</a></h2>
<h3 class="function"><a name="destroy-1">destroy/1</a></h3>
<div class="spec">
<p><tt>destroy(Varpool::#varpool{owner = pid(), supervisor = pid(), max_r = non_neg_integer(), max_t = pos_integer(), groups = <a href="dict.html#type-dict">dict:dict</a>(any(), #group{count_hash = pos_integer(), count_random = pos_integer(), count_total = pos_integer(), hash = fun((any(), pos_integer()) -> non_neg_integer()), random = fun((pos_integer()) -> non_neg_integer()), processes = <a href="array.html#type-array">array:array</a>(pid())}), processes = <a href="dict.html#type-dict">dict:dict</a>(pid(), {any(), non_neg_integer()}), monitors = [reference()]}) -> ok</tt><br></p>
</div>
<h3 class="function"><a name="get-2">get/2</a></h3>
<div class="spec">
<p><tt>get(Group::any(), Varpool::#varpool{owner = pid(), supervisor = pid(), max_r = non_neg_integer(), max_t = pos_integer(), groups = <a href="dict.html#type-dict">dict:dict</a>(any(), #group{count_hash = pos_integer(), count_random = pos_integer(), count_total = pos_integer(), hash = fun((any(), pos_integer()) -> non_neg_integer()), random = fun((pos_integer()) -> non_neg_integer()), processes = <a href="array.html#type-array">array:array</a>(pid())}), processes = <a href="dict.html#type-dict">dict:dict</a>(pid(), {any(), non_neg_integer()}), monitors = [reference()]}) -> pid() | undefined</tt><br></p>
</div>
<h3 class="function"><a name="get-3">get/3</a></h3>
<div class="spec">
<p><tt>get(Group::any(), Key::any(), Varpool::#varpool{owner = pid(), supervisor = pid(), max_r = non_neg_integer(), max_t = pos_integer(), groups = <a href="dict.html#type-dict">dict:dict</a>(any(), #group{count_hash = pos_integer(), count_random = pos_integer(), count_total = pos_integer(), hash = fun((any(), pos_integer()) -> non_neg_integer()), random = fun((pos_integer()) -> non_neg_integer()), processes = <a href="array.html#type-array">array:array</a>(pid())}), processes = <a href="dict.html#type-dict">dict:dict</a>(pid(), {any(), non_neg_integer()}), monitors = [reference()]}) -> pid() | undefined</tt><br></p>
</div>
<h3 class="function"><a name="new-1">new/1</a></h3>
<div class="spec">
<p><tt>new(Options::<a href="#type-options">options()</a>) -> #varpool{owner = pid(), supervisor = pid(), max_r = non_neg_integer(), max_t = pos_integer(), groups = <a href="dict.html#type-dict">dict:dict</a>(any(), #group{count_hash = pos_integer(), count_random = pos_integer(), count_total = pos_integer(), hash = fun((any(), pos_integer()) -> non_neg_integer()), random = fun((pos_integer()) -> non_neg_integer()), processes = <a href="array.html#type-array">array:array</a>(pid())}), processes = <a href="dict.html#type-dict">dict:dict</a>(pid(), {any(), non_neg_integer()}), monitors = [reference()]}</tt><br></p>
</div>
<h3 class="function"><a name="update-2">update/2</a></h3>
<div class="spec">
<p><tt>update(X1::any(), Varpool::#varpool{owner = pid(), supervisor = pid(), max_r = non_neg_integer(), max_t = pos_integer(), groups = <a href="dict.html#type-dict">dict:dict</a>(any(), #group{count_hash = pos_integer(), count_random = pos_integer(), count_total = pos_integer(), hash = fun((any(), pos_integer()) -> non_neg_integer()), random = fun((pos_integer()) -> non_neg_integer()), processes = <a href="array.html#type-array">array:array</a>(pid())}), processes = <a href="dict.html#type-dict">dict:dict</a>(pid(), {any(), non_neg_integer()}), monitors = [reference()]}) -> {updated, #varpool{owner = pid(), supervisor = pid(), max_r = non_neg_integer(), max_t = pos_integer(), groups = <a href="dict.html#type-dict">dict:dict</a>(any(), #group{count_hash = pos_integer(), count_random = pos_integer(), count_total = pos_integer(), hash = fun((any(), pos_integer()) -> non_neg_integer()), random = fun((pos_integer()) -> non_neg_integer()), processes = <a href="array.html#type-array">array:array</a>(pid())}), processes = <a href="dict.html#type-dict">dict:dict</a>(pid(), {any(), non_neg_integer()}), monitors = [reference()]}} | {ignored, #varpool{owner = pid(), supervisor = pid(), max_r = non_neg_integer(), max_t = pos_integer(), groups = <a href="dict.html#type-dict">dict:dict</a>(any(), #group{count_hash = pos_integer(), count_random = pos_integer(), count_total = pos_integer(), hash = fun((any(), pos_integer()) -> non_neg_integer()), random = fun((pos_integer()) -> non_neg_integer()), processes = <a href="array.html#type-array">array:array</a>(pid())}), processes = <a href="dict.html#type-dict">dict:dict</a>(pid(), {any(), non_neg_integer()}), monitors = [reference()]}}</tt><br></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>