Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | Related Pages

AdhocCommandProvider Class Reference

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

#include <adhoccommandprovider.h>

List of all members.

Public Member Functions

virtual ~AdhocCommandProvider ()
virtual void handleAdhocCommand (const JID &from, const Adhoc::Command &command, const std::string &sessionID)=0


Detailed Description

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

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

Author:
Jakob Schroeter <js@camaya.net>

Definition at line 36 of file adhoccommandprovider.h.


Constructor & Destructor Documentation

virtual ~AdhocCommandProvider  )  [inline, virtual]
 

Virtual destructor.

Definition at line 42 of file adhoccommandprovider.h.


Member Function Documentation

virtual void handleAdhocCommand const JID from,
const Adhoc::Command command,
const std::string &  sessionID
[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:
from The sender of the command request.
command The name of the command to be executed.
sessionID The session ID. Either newly generated or taken from the command. When responding, its value must be passed to Adhoc::Command's constructor.


The documentation for this class was generated from the following file:
Generated on Tue Apr 22 15:10:13 2008 for gloox by  doxygen 1.4.1