mirror of
https://github.com/ubf/ubf.git
synced 2026-04-21 20:25:57 +00:00
73 lines
3.2 KiB
HTML
73 lines
3.2 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<title>Module contract_driver</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_driver</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>Generic protocol driver process for protocol sessions.
|
|
|
|
|
|
<h2><a name="description">Description</a></h2><p>Generic protocol driver process for protocol sessions.</p>
|
|
|
|
<img src="../priv/doc/ubf-flow-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="#behaviour_info-1">behaviour_info/1</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#loop-4">loop/4</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#loop-5">loop/5</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#loop-6">loop/6</a></td><td>Driver main loop.</td></tr>
|
|
<tr><td valign="top"><a href="#relay-3">relay/3</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#start-2">start/2</a></td><td></td></tr>
|
|
</table>
|
|
|
|
<h2><a name="functions">Function Details</a></h2>
|
|
|
|
<h3 class="function"><a name="behaviour_info-1">behaviour_info/1</a></h3>
|
|
<div class="spec">
|
|
<p><tt>behaviour_info(X1) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="loop-4">loop/4</a></h3>
|
|
<div class="spec">
|
|
<p><tt>loop(Module, Contract, Pid, Socket) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="loop-5">loop/5</a></h3>
|
|
<div class="spec">
|
|
<p><tt>loop(Module, Contract, Pid, Socket, Timeout) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="loop-6">loop/6</a></h3>
|
|
<div class="spec">
|
|
<p><tt>loop(Module, Contract, Pid, Socket, Timeout, Cont) -> any()</tt></p>
|
|
</div><p><p>Driver main loop.</p>
|
|
|
|
<ul>
|
|
<li> A driver sits between a socket and a Pid </li>
|
|
<li> Stuff on the socket is send to the Pid </li>
|
|
<li> Stuff from the Pid is send to the socket </li>
|
|
<li> When it is called the Socket has been set to send messages to
|
|
the driver and the Pid exists </li>
|
|
<li> If one side dies the process dies </li>
|
|
</ul></p>
|
|
|
|
<h3 class="function"><a name="relay-3">relay/3</a></h3>
|
|
<div class="spec">
|
|
<p><tt>relay(Module, Pid, Pid1) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="start-2">start/2</a></h3>
|
|
<div class="spec">
|
|
<p><tt>start(Module, Contract) -> 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 EDoc, $Id$</i></p>
|
|
</body>
|
|
</html>
|