84 lines
2.4 KiB
C
84 lines
2.4 KiB
C
|
/*
|
||
|
|
Copyright (c) 2004-2009 by Jakob Schroeter <js@camaya.net>
|
||
|
|
This file is part of the gloox library. http://camaya.net/gloox
|
||
|
|
|
||
|
|
This software is distributed under a license. The full license
|
||
|
|
agreement can be found in the file LICENSE in this distribution.
|
||
|
|
This software may not be copied, modified, sold or distributed
|
||
|
|
other than expressed in the named license agreement.
|
||
|
|
|
||
|
|
This software is distributed without any warranty.
|
||
|
|
*/
|
||
|
|
|
||
|
|
|
||
|
|
#ifndef DISCOHANDLER_H__
|
||
|
|
#define DISCOHANDLER_H__
|
||
|
|
|
||
|
|
#include "macros.h"
|
||
|
|
#include "disco.h"
|
||
|
|
|
||
|
|
#include <string>
|
||
|
|
|
||
|
|
namespace gloox
|
||
|
|
{
|
||
|
|
|
||
|
|
class IQ;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief A virtual interface that enables objects to receive Service Discovery (XEP-0030) events.
|
||
|
|
*
|
||
|
|
* A class implementing this interface can receive the results of sent disco queries.
|
||
|
|
*
|
||
|
|
* @author Jakob Schroeter <js@camaya.net>
|
||
|
|
*/
|
||
|
|
class GLOOX_API DiscoHandler
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
/**
|
||
|
|
* Virtual Destructor.
|
||
|
|
*/
|
||
|
|
virtual ~DiscoHandler() {}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Reimplement this function if you want to be notified about the result
|
||
|
|
* of an disco#info query.
|
||
|
|
* @param from The sender of the disco#info result.
|
||
|
|
* @param info The Info.
|
||
|
|
* @param context A context identifier.
|
||
|
|
* @since 1.0
|
||
|
|
*/
|
||
|
|
virtual void handleDiscoInfo( const JID& from, const Disco::Info& info, int context ) = 0;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Reimplement this function if you want to be notified about the result
|
||
|
|
* of a disco#items query.
|
||
|
|
* @param from The sender of the disco#items result.
|
||
|
|
* @param items The Items.
|
||
|
|
* @param context A context identifier.
|
||
|
|
* @since 1.0
|
||
|
|
*/
|
||
|
|
virtual void handleDiscoItems( const JID& from, const Disco::Items& items, int context ) = 0;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Reimplement this function to receive disco error notifications.
|
||
|
|
* @param from The sender of the error result.
|
||
|
|
* @param error The Error. May be 0.
|
||
|
|
* @param context A context identifier.
|
||
|
|
* @since 1.0
|
||
|
|
*/
|
||
|
|
virtual void handleDiscoError( const JID& from, const Error* error, int context ) = 0;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Reimplement this function to receive notifications about incoming IQ
|
||
|
|
* stanzas of type 'set' in the disco namespace.
|
||
|
|
* @param iq The full IQ.
|
||
|
|
* @return Returns @b true if the stanza was handled and answered, @b false otherwise.
|
||
|
|
*/
|
||
|
|
virtual bool handleDiscoSet( const IQ& iq ) { (void)iq; return false; }
|
||
|
|
|
||
|
|
};
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
#endif // DISCOHANDLER_H__
|