EDoc update
This commit is contained in:
parent
8afc844d1f
commit
51d6c48313
18 changed files with 44 additions and 19 deletions
|
@ -55,6 +55,6 @@
|
|||
<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, May 20 2015, 12:36:35.</i></p>
|
||||
<p><i>Generated by EDoc, May 20 2015, 12:50:53.</i></p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
@ -34,6 +34,6 @@
|
|||
<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, May 20 2015, 12:36:35.</i></p>
|
||||
<p><i>Generated by EDoc, May 20 2015, 12:50:53.</i></p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
@ -174,6 +174,6 @@ distributed state of a single Machi Chain Replication chain.</p>
|
|||
<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, May 20 2015, 12:36:35.</i></p>
|
||||
<p><i>Generated by EDoc, May 20 2015, 12:50:53.</i></p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
@ -86,6 +86,6 @@ in sync. In theory, that's lower overhead than the procedure used here.</p>
|
|||
<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, May 20 2015, 12:36:35.</i></p>
|
||||
<p><i>Generated by EDoc, May 20 2015, 12:50:53.</i></p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
@ -166,6 +166,6 @@ list.</p>
|
|||
<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, May 20 2015, 12:36:35.</i></p>
|
||||
<p><i>Generated by EDoc, May 20 2015, 12:50:53.</i></p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
@ -224,6 +224,6 @@ function name.)</p>
|
|||
<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, May 20 2015, 12:36:35.</i></p>
|
||||
<p><i>Generated by EDoc, May 20 2015, 12:50:53.</i></p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
@ -101,6 +101,6 @@ replication/chain repair.</p>
|
|||
<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, May 20 2015, 12:36:35.</i></p>
|
||||
<p><i>Generated by EDoc, May 20 2015, 12:50:53.</i></p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
@ -364,6 +364,6 @@ etc.</p>
|
|||
<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, May 20 2015, 12:36:35.</i></p>
|
||||
<p><i>Generated by EDoc, May 20 2015, 12:50:53.</i></p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
@ -26,7 +26,32 @@ servers.</p>
|
|||
supervisor is responsible for managing those three major services
|
||||
as a single "package", to be started & stopped together.</p>
|
||||
|
||||
<img src="/machi/images/supervisor-2flus.png">
|
||||
<p>The illustration below shows the OTP process supervision tree for
|
||||
the Machi application. Two FLUs are running, called <code>a</code> and <code>b</code>.
|
||||
The chain is configured for a third FLU, <code>c</code>, which is not running
|
||||
at this time.</p>
|
||||
|
||||
<p><img src="/machi//images/supervisor-2flus.png"></p>
|
||||
|
||||
<ul>
|
||||
<li> The FLU process itself is named <code>a</code>.
|
||||
</li>
|
||||
<li> The projection store process is named <code>a_pstore</code>.
|
||||
</li>
|
||||
<li> The chain manager process is named <code>a_chmgr</code>. The three
|
||||
linked subprocesses are long-lived <a href="machi_proxy_flu1_client.html"><code>machi_proxy_flu1_client</code></a> processes for communicating to all
|
||||
chain participants' projection stores (including the local
|
||||
store <code>a_pstore</code>).
|
||||
</li>
|
||||
<li> A fourth major process, <code>a_listener</code>, which is responsible for
|
||||
listening on a TCP socket and creating new connections.
|
||||
Currently, each listener has two processes handling incoming
|
||||
requests, one from each chain manager proxy.
|
||||
</li>
|
||||
<li> Note that the sub-supervisor parent of <code>a</code> and <code>a_listener</code> does
|
||||
not have a registered name.
|
||||
</li>
|
||||
</ul>
|
||||
<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="#init-1">init/1</a></td><td></td></tr>
|
||||
<tr><td valign="top"><a href="#make_mgr_supname-1">make_mgr_supname/1</a></td><td></td></tr>
|
||||
|
@ -82,6 +107,6 @@ servers.</p>
|
|||
<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, May 20 2015, 12:36:35.</i></p>
|
||||
<p><i>Generated by EDoc, May 20 2015, 12:50:53.</i></p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
@ -36,6 +36,6 @@
|
|||
<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, May 20 2015, 12:36:35.</i></p>
|
||||
<p><i>Generated by EDoc, May 20 2015, 12:50:53.</i></p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
@ -89,6 +89,6 @@ correctly.</p>
|
|||
<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, May 20 2015, 12:36:35.</i></p>
|
||||
<p><i>Generated by EDoc, May 20 2015, 12:50:53.</i></p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
@ -164,6 +164,6 @@ module's API.</p>
|
|||
<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, May 20 2015, 12:36:35.</i></p>
|
||||
<p><i>Generated by EDoc, May 20 2015, 12:50:53.</i></p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
@ -288,6 +288,6 @@ TCP communication problems with the remote server.</p>
|
|||
<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, May 20 2015, 12:36:35.</i></p>
|
||||
<p><i>Generated by EDoc, May 20 2015, 12:50:53.</i></p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
@ -18,6 +18,6 @@
|
|||
the future?<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, May 20 2015, 12:36:35.</i></p>
|
||||
<p><i>Generated by EDoc, May 20 2015, 12:50:53.</i></p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
@ -34,6 +34,6 @@
|
|||
<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, May 20 2015, 12:36:35.</i></p>
|
||||
<p><i>Generated by EDoc, May 20 2015, 12:50:53.</i></p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
@ -163,6 +163,6 @@
|
|||
<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, May 20 2015, 12:36:35.</i></p>
|
||||
<p><i>Generated by EDoc, May 20 2015, 12:50:53.</i></p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
@ -337,6 +337,6 @@
|
|||
<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, May 20 2015, 12:36:35.</i></p>
|
||||
<p><i>Generated by EDoc, May 20 2015, 12:50:53.</i></p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
@ -180,6 +180,6 @@ the code, is a reminder signal of unfinished work.</p>
|
|||
|
||||
<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, May 20 2015, 12:36:35.</i></p>
|
||||
<p><i>Generated by EDoc, May 20 2015, 12:50:53.</i></p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
Loading…
Reference in a new issue