mirror of
https://github.com/ubf/ubf.git
synced 2026-04-20 11:45:58 +00:00
61 lines
2.8 KiB
HTML
61 lines
2.8 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<title>Module ebf_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 ebf_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>Protocol driver process for EBF (Erlang Binary Format)
|
|
protocol sessions.
|
|
|
|
|
|
<h2><a name="description">Description</a></h2><p>Protocol driver process for EBF (Erlang Binary Format)
|
|
protocol sessions.</p>
|
|
|
|
<p>This driver automagically relies on the OTP <code>gen_tcp</code> "packet"
|
|
feature, using a 4-byte prefix to specify the size of the data
|
|
coming from the client. Similarly, this packet feature is used
|
|
when sending our reply back to the client.</p>
|
|
|
|
The process executing <code>loop()</code> in this module is represented in the
|
|
diagram below by the "UBF Driver" circle.
|
|
<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="#decode-4">decode/4</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#encode-2">encode/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="#start-1">start/1</a></td><td></td></tr>
|
|
</table>
|
|
|
|
<h2><a name="functions">Function Details</a></h2>
|
|
|
|
<h3 class="function"><a name="decode-4">decode/4</a></h3>
|
|
<div class="spec">
|
|
<p><tt>decode(Contract, Cont, Binary, CallBack) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="encode-2">encode/2</a></h3>
|
|
<div class="spec">
|
|
<p><tt>encode(Contract, Term) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="init-1">init/1</a></h3>
|
|
<div class="spec">
|
|
<p><tt>init(Contract) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="start-1">start/1</a></h3>
|
|
<div class="spec">
|
|
<p><tt>start(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>
|