mirror of
https://github.com/ubf/ubf.git
synced 2026-04-20 19:55:35 +00:00
117 lines
4.7 KiB
HTML
117 lines
4.7 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<title>Module ubf</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 ubf</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>Low-level functions for encoding and decoding the UBF(A)
|
|
protocol.
|
|
|
|
|
|
<h2><a name="description">Description</a></h2><p>Low-level functions for encoding and decoding the UBF(A)
|
|
protocol.</p>
|
|
|
|
<p>UBF is a family of languages for transporting and describing
|
|
complex data structures across a network. It has three
|
|
components. In terms of a protocol stack, UBF(A) is a data
|
|
transport format, roughly equivalent to well-formed XML.</p>
|
|
|
|
<h3><a name="Quick_Summary">Quick Summary</a></h3>
|
|
|
|
<p>UBF(A) is the transport format, it was designed to be easy to
|
|
parse and to be easy to write with a text editor. UBF(A) is based
|
|
on a byte encoded virtual machine, 26 byte codes are
|
|
reserved. Instead of allocating the byte codes from 0 we use the
|
|
printable character codes to make the format easy to read.</p>
|
|
|
|
For more information, please see the following:
|
|
<ul>
|
|
<li> <a href="../priv/doc/doc/site/ubfa.html">Joe Armstrong's UBF(A) summary</a> </li>
|
|
<li> <a href="../priv/doc/doc/site/ubfa_quick.html">Joe Armstrong's UBF(A) quick-reference summary</a> </li>
|
|
</ul>
|
|
|
|
<h3><a name="Hint:_Decoding_rules">Hint: Decoding rules</a></h3>
|
|
|
|
<ul>
|
|
<li> {'#S', String} -> String </li>
|
|
<li> Int -> Int </li>
|
|
<li> [ ] -> List </li>
|
|
<li> {...} -> Tuple </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="#deabstract-1">deabstract/1</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#decode-1">decode/1</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#decode-2">decode/2</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#decode-3">decode/3</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#decode_init-0">decode_init/0</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#encode-1">encode/1</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="#proto_driver-0">proto_driver/0</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#proto_packet_type-0">proto_packet_type/0</a></td><td></td></tr>
|
|
<tr><td valign="top"><a href="#proto_vsn-0">proto_vsn/0</a></td><td></td></tr>
|
|
</table>
|
|
|
|
<h2><a name="functions">Function Details</a></h2>
|
|
|
|
<h3 class="function"><a name="deabstract-1">deabstract/1</a></h3>
|
|
<div class="spec">
|
|
<p><tt>deabstract(T) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="decode-1">decode/1</a></h3>
|
|
<div class="spec">
|
|
<p><tt>decode(Str) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="decode-2">decode/2</a></h3>
|
|
<div class="spec">
|
|
<p><tt>decode(Str, Mod) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="decode-3">decode/3</a></h3>
|
|
<div class="spec">
|
|
<p><tt>decode(S, Mod, X3) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="decode_init-0">decode_init/0</a></h3>
|
|
<div class="spec">
|
|
<p><tt>decode_init() -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="encode-1">encode/1</a></h3>
|
|
<div class="spec">
|
|
<p><tt>encode(X) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="encode-2">encode/2</a></h3>
|
|
<div class="spec">
|
|
<p><tt>encode(X, Mod) -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="proto_driver-0">proto_driver/0</a></h3>
|
|
<div class="spec">
|
|
<p><tt>proto_driver() -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="proto_packet_type-0">proto_packet_type/0</a></h3>
|
|
<div class="spec">
|
|
<p><tt>proto_packet_type() -> any()</tt></p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="proto_vsn-0">proto_vsn/0</a></h3>
|
|
<div class="spec">
|
|
<p><tt>proto_vsn() -> 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>
|