AdhocCommandProvider Class Reference

A virtual interface for an Ad-hoc Command Provider according to JEP-0050. More...

#include <adhoccommandprovider.h>

List of all members.

Public Member Functions

virtual ~AdhocCommandProvider ()
virtual void handleAdhocCommand (const std::string &command, Tag *tag, const JID &from, const std::string &id)=0


Detailed Description

A virtual interface for an Ad-hoc Command Provider according to JEP-0050.

Derived classes can be registered as Command Providers with the Adhoc object.

Author:
Jakob Schroeter <js@camaya.net>

Definition at line 34 of file adhoccommandprovider.h.


Constructor & Destructor Documentation

virtual ~AdhocCommandProvider (  )  [inline, virtual]

Virtual destructor.

Definition at line 40 of file adhoccommandprovider.h.


Member Function Documentation

virtual void handleAdhocCommand ( const std::string &  command,
Tag tag,
const JID from,
const std::string &  id 
) [pure virtual]

This function is called when an Ad-hoc Command needs to be handled. The callee is responsible for the whole command execution, i.e. session handling etc.

Parameters:
command The name of the command to be executed.
tag The complete command tag.
from The sender of the command request.
id The command's id. An opaque string which should be used only as the id of the iq result or error stanza.


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