mirror of
https://github.com/ubf/ubf.git
synced 2026-04-19 03:05:42 +00:00
73 lines
1.6 KiB
Markdown
73 lines
1.6 KiB
Markdown
|
|
|
|
# Module ebf_driver #
|
|
* [Description](#description)
|
|
* [Function Index](#index)
|
|
* [Function Details](#functions)
|
|
|
|
|
|
<p>Protocol driver process for EBF (Erlang Binary Format)
|
|
protocol sessions.</p>
|
|
|
|
|
|
<pre><code>This driver automagically relies on the OTP +gen_tcp+ "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.</code></pre>
|
|
.
|
|
__Behaviours:__ [`contract_driver`](contract_driver.md).
|
|
<a name="index"></a>
|
|
|
|
## Function Index ##
|
|
|
|
|
|
<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-3">encode/3</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="#init-2">init/2</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-2">start/2</a></td><td></td></tr></table>
|
|
|
|
|
|
<a name="functions"></a>
|
|
|
|
## Function Details ##
|
|
|
|
<a name="decode-4"></a>
|
|
|
|
### decode/4 ###
|
|
|
|
`decode(Contract, Options, X3, Binary) -> any()`
|
|
|
|
|
|
<a name="encode-3"></a>
|
|
|
|
### encode/3 ###
|
|
|
|
`encode(Contract, Options, Term) -> any()`
|
|
|
|
|
|
<a name="init-1"></a>
|
|
|
|
### init/1 ###
|
|
|
|
`init(Contract) -> any()`
|
|
|
|
|
|
<a name="init-2"></a>
|
|
|
|
### init/2 ###
|
|
|
|
`init(Contract, Options) -> any()`
|
|
|
|
|
|
<a name="start-1"></a>
|
|
|
|
### start/1 ###
|
|
|
|
`start(Contract) -> any()`
|
|
|
|
|
|
<a name="start-2"></a>
|
|
|
|
### start/2 ###
|
|
|
|
`start(Contract, Options) -> any()`
|
|
|
|
|