DiscoNodeHandler Class Reference

Derived classes can be registered as NodeHandlers for certain nodes with the Disco object. More...

#include <disconodehandler.h>

Inherited by Adhoc.

Inheritance diagram for DiscoNodeHandler:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual ~DiscoNodeHandler ()
virtual StringList handleDiscoNodeFeatures (const std::string &node)=0
virtual StringMap handleDiscoNodeIdentities (const std::string &node, std::string &name)=0
virtual StringMap handleDiscoNodeItems (const std::string &node="")=0

Detailed Description

Derived classes can be registered as NodeHandlers for certain nodes with the Disco object.

Incoming disco::info and disco::items queries are delegated to their respective handlers.

Author:
Jakob Schroeter <js@camaya.net>

Definition at line 31 of file disconodehandler.h.


Constructor & Destructor Documentation

virtual ~DiscoNodeHandler (  )  [inline, virtual]

Virtual Destructor.

Definition at line 37 of file disconodehandler.h.


Member Function Documentation

virtual StringList handleDiscoNodeFeatures ( const std::string &  node  )  [pure virtual]

In addition to handleDiscoNodeIdentities, this function is used to gather more information on a specific node. It is called when a disco::info query arrives with a node attribute that matches the one registered for this handler.

Parameters:
node The node this handler is supposed to handle.
Returns:
A list of features supported by this node.

Implemented in Adhoc.

virtual StringMap handleDiscoNodeIdentities ( const std::string &  node,
std::string &  name 
) [pure virtual]

In addition to handleDiscoNodeFeatures, this function is used to gather more information on a specific node. It is called when a disco::info query arrives with a node attribute that matches the one registered for this handler.

Parameters:
node The node this handler is supposed to handle.
name This parameter is currently used as additional return value. Just fill in the name of the node.
Returns:
A map of identities for the given node. The first string is the category specifier, the second string is the type specifier.

Implemented in Adhoc.

virtual StringMap handleDiscoNodeItems ( const std::string &  node = ""  )  [pure virtual]

This function is used to gather more information on a specific node. It is called when a disco::items query arrives with a node attribute that matches the one registered for this handler. If node is empty, items for the root node (no node) shall be returned.

Parameters:
node The node this handler is supposed to handle.
Returns:
A map of items supported by this node. The first string is the item's node specifier, the second string is the items natural-language name.

Implemented in Adhoc.


The documentation for this class was generated from the following file:
Generated on Tue May 1 14:20:23 2007 for gloox by  doxygen 1.5.1