| Overview |     |
Copyright © 2006-2012 ProcessOne
Version: 3.0.0-alpha-5, May 23 2012 07:15:12
Behaviours: gen_pubsub_nodetree.
Authors: Christophe Romain (christophe.romain@process-one.net) [web site: http://www.process-one.net/].
PubSub node tree plugins are using the gen_nodetree behaviour.
The development of this plugin is still a work in progress. Due to optimizations in mod_pubsub, this plugin can not work anymore without altering functioning. Please, send us comments, feedback and improvements.
| create_node/6 | No node record is stored on database. |
| delete_node/2 | Virtual node tree does not handle parent/child. |
| get_node/1 | |
| get_node/2 | |
| get_node/3 | Virtual node tree does not handle a node database. |
| get_nodes/1 | |
| get_nodes/2 | Virtual node tree does not handle a node database. |
| get_subnodes/2* | |
| get_subnodes/3 | Virtual node tree does not handle parent/child. |
| get_subnodes_tree/2* | |
| get_subnodes_tree/3 | Virtual node tree does not handle parent/child. |
| init/3 | Called during pubsub modules initialisation. |
| options/0 | Returns the default pubsub node tree options. |
| set_node/1 | No node record is stored on database. |
| terminate/2 |
create_node(Host, Node, Type, Owner, Options, Parents) -> ok
No node record is stored on database. Any valid node is considered as already created.
default allowed nodes: /home/host/user/any/node/name
delete_node(Host, Node) -> [mod_pubsub:node()]
Virtual node tree does not handle parent/child. node deletion just affects the corresponding node.
get_node(NodeId) -> any()
get_node(Host, Node) -> any()
get_node(Host, Node, From) -> pubsubNode()
Virtual node tree does not handle a node database. Any node is considered as existing. Node record contains default values.
get_nodes(Host) -> any()
get_nodes(Host, From) -> [pubsubNode()]
Virtual node tree does not handle a node database. Any node is considered as existing. Nodes list can not be determined.
get_subnodes(Host, Node) -> any()
get_subnodes(Host, Node, From) -> [pubsubNode()]
Virtual node tree does not handle parent/child. Child list is empty.
get_subnodes_tree(Host, Node) -> any()
get_subnodes_tree(Host, Node::Index, From) -> [pubsubNode()]
Virtual node tree does not handle parent/child. Child list is empty.
init(Host, ServerHost, Opts) -> any()
Called during pubsub modules initialisation. Any pubsub plugin must implement this function. It can return anything.
This function is mainly used to trigger the setup task necessary for the plugin. It can be used for example by the developer to create the specific module database schema if it does not exists yet.
options() -> [Option]
Returns the default pubsub node tree options.
set_node(NodeRecord) -> ok | {error, Reason}
No node record is stored on database. Just do nothing.
terminate(Host, ServerHost) -> any()
Generated by EDoc, May 23 2012, 07:15:12.