Permalink
Fetching contributors…
Cannot retrieve contributors at this time
118 lines (65 sloc) 3.47 KB

Abstract module ubf_plugin_meta_stateful [MODULES]

Implement the UBF(c) meta-protocol for UBF(b) "stateful" contracts.

The metaprotocol is used at the beginning of a UBF session to
select one of the UBF(b) contracts that the TCP listener is
capable of offering.  The list of contracts (or more precisely,
the Erlang modules that implement the contract(s)) is passed via
the +ubf_server:start_link()+ function, in the +PluginModule+
list.
Code in this module is executed by the "Plugin Handler" process in
the Process Structure Diagram in the Overview.
For the purposes of this module, the list of modules that
implement contracts is passed using parameterized module
+Module:new(ModuleList)+ syntax.

.

Function Index

description/0

Emit a description string.

.
handlerRpc/4

Required UBF contract implementation callback: call an RPC function.

.
handlerStart/2

Required UBF contract implementation callback: start a new session handler process.

.
handlerStop/3

Required UBF contract implementation callback: stop a session handler process.

.
info/0

Emit an info string.

.
managerRestart/2

Required UBF contract implementation callback: restart a manager process.

.
managerRpc/2

Required UBF contract implementation callback: call a manager's RPC function.

.
managerStart/1

Required UBF contract implementation callback: start manager process(es).

.

Function Details

description/0

description() -> any()

Emit a description string.

handlerRpc/4

handlerRpc(State, X2, Data, Manager) -> any()

Required UBF contract implementation callback: call an RPC function.

handlerStart/2

handlerStart(X1, X2) -> any()

Required UBF contract implementation callback: start a new session handler process.

handlerStop/3

handlerStop(Pid, Reason, ManagerData) -> any()

Required UBF contract implementation callback: stop a session handler process.

info/0

info() -> any()

Emit an info string.

managerRestart/2

managerRestart(Args, Manager) -> any()

Required UBF contract implementation callback: restart a manager process.

managerRpc/2

managerRpc(X1, S) -> any()

Required UBF contract implementation callback: call a manager's RPC function.

managerStart/1

managerStart(Args) -> any()

Required UBF contract implementation callback: start manager process(es).