1
0
mirror of https://github.com/ubf/ubf.git synced 2026-04-20 19:55:35 +00:00
Files
ubf/doc/contract_driver.md
Joseph Wayne Norton 39468d05e2 Update docs
2013-03-26 12:41:39 +09:00

60 lines
1.3 KiB
Markdown

# Module contract_driver #
* [Description](#description)
* [Function Index](#index)
* [Function Details](#functions)
<p>Generic protocol driver process for protocol sessions.</p>.
__This module defines the `contract_driver` behaviour.__
<br></br>
Required callback functions: `start/1`, `start/2`, `init/1`, `init/2`, `encode/3`, `decode/4`.
<a name="index"></a>
## Function Index ##
<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-5">loop/5</a></td><td></td></tr><tr><td valign="top"><a href="#loop-6">loop/6</a></td><td></td></tr><tr><td valign="top"><a href="#relay-3">relay/3</a></td><td></td></tr><tr><td valign="top"><a href="#start-3">start/3</a></td><td></td></tr></table>
<a name="functions"></a>
## Function Details ##
<a name="behaviour_info-1"></a>
### behaviour_info/1 ###
`behaviour_info(Other) -> any()`
<a name="loop-5"></a>
### loop/5 ###
`loop(Module, Contract, Options, Pid, Socket) -> any()`
<a name="loop-6"></a>
### loop/6 ###
`loop(Module, Contract, Options, Pid, Socket, Timeout) -> any()`
<a name="relay-3"></a>
### relay/3 ###
`relay(Module, Pid, Pid1) -> any()`
<a name="start-3"></a>
### start/3 ###
`start(Module, Contract, Options) -> any()`