mirror of
https://github.com/ubf/ubf.git
synced 2026-04-23 13:16:05 +00:00
109 lines
4.8 KiB
HTML
109 lines
4.8 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<title>Module contract_manager</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 contract_manager</h1>
|
|
<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>Contract manager server.
|
|
|
|
|
|
<h2><a name="description">Description</a></h2><p>Contract manager server</p>
|
|
|
|
<p>This module implements the contract manager server process, which
|
|
runs on the Erlang server side, between the UBF driver (or the
|
|
driver for whatever protocol is being used "over the wire",
|
|
e.g. JSON-RPC) and the plugin handler server.</p>
|
|
|
|
<p><img src="../priv/doc/ubf-flow-01.png"></p>
|
|
|
|
<h3><a name="Message_Passing">Message Passing</a></h3>
|
|
|
|
<p>In the diagram below, the "Client" is actually the UBF driver
|
|
(using UBF, EBF, JSON, JSON-RPC, or other transport protocol) that
|
|
acts on behalf of the remote client. The "Server" is actually the
|
|
plugin handler server, which acts as an intermediary between the
|
|
actual server application.</p>
|
|
|
|
<img src="../priv/doc/contract_manager-01.png">
|
|
<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="#do_eventIn-4">do_eventIn/4</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#do_eventOut-4">do_eventOut/4</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#do_lpcIn-4">do_lpcIn/4</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#do_lpcOut-9">do_lpcOut/9</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#do_lpcOutError-6">do_lpcOutError/6</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#do_rpcIn-4">do_rpcIn/4</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#do_rpcOut-9">do_rpcOut/9</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#do_rpcOutError-5">do_rpcOutError/5</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#do_rpcOutError-6">do_rpcOutError/6</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#start-1">start/1</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#start-3">start/3</a></td><td></td></tr>
|
|
</table>
|
|
|
|
<h2><a name="functions">Function Details</a></h2>
|
|
|
|
<h3 class="function"><a name="do_eventIn-4">do_eventIn/4</a></h3>
|
|
<div class="spec">
|
|
<p><tt>do_eventIn(Msg, State, Mod, TLogMod) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="do_eventOut-4">do_eventOut/4</a></h3>
|
|
<div class="spec">
|
|
<p><tt>do_eventOut(Msg, State, Mod, TLogMod) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="do_lpcIn-4">do_lpcIn/4</a></h3>
|
|
<div class="spec">
|
|
<p><tt>do_lpcIn(Q, State, Mod, TLogMod) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="do_lpcOut-9">do_lpcOut/9</a></h3>
|
|
<div class="spec">
|
|
<p><tt>do_lpcOut(Ref, Q, State, Mod, Reply, ReplyState, NewState, NewMod, TLogMod) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="do_lpcOutError-6">do_lpcOutError/6</a></h3>
|
|
<div class="spec">
|
|
<p><tt>do_lpcOutError(Ref, Q, State, Mod, Error, TLogMod) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="do_rpcIn-4">do_rpcIn/4</a></h3>
|
|
<div class="spec">
|
|
<p><tt>do_rpcIn(Q, State, Mod, TLogMod) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="do_rpcOut-9">do_rpcOut/9</a></h3>
|
|
<div class="spec">
|
|
<p><tt>do_rpcOut(Ref, Q, State, Mod, Reply, ReplyState, NewState, NewMod, TLogMod) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="do_rpcOutError-5">do_rpcOutError/5</a></h3>
|
|
<div class="spec">
|
|
<p><tt>do_rpcOutError(Q, State, Mod, Error, TLogMod) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="do_rpcOutError-6">do_rpcOutError/6</a></h3>
|
|
<div class="spec">
|
|
<p><tt>do_rpcOutError(Ref, Q, State, Mod, Error, TLogMod) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="start-1">start/1</a></h3>
|
|
<div class="spec">
|
|
<p><tt>start(SpawnOpts::list()) -> pid()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="start-3">start/3</a></h3>
|
|
<div class="spec">
|
|
<p><tt>start(SimpleRPC::bool(), VerboseRPC::bool(), SpawnOpts::list()) -> pid()</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 EDoc, $Id$</i></p>
|
|
</body>
|
|
</html>
|