gloox  1.0
Public Member Functions
IqHandler Class Reference

#include <iqhandler.h>

Inheritance diagram for IqHandler:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~IqHandler ()
virtual bool handleIq (const IQ &iq)=0
virtual void handleIqID (const IQ &iq, int context)=0

Detailed Description

A virtual interface which can be reimplemented to receive IQ stanzas.

Derived classes can be registered as IqHandlers with the Client. Upon an incoming IQ packet handleIq() will be called.

Author:
Jakob Schroeter <js@camaya.net>

Definition at line 31 of file iqhandler.h.


Constructor & Destructor Documentation

virtual ~IqHandler ( ) [inline, virtual]

Virtual Destructor.

Definition at line 37 of file iqhandler.h.


Member Function Documentation

virtual bool handleIq ( const IQ iq) [pure virtual]

Reimplement this function if you want to be notified about incoming IQs.

Parameters:
iqThe complete IQ stanza.
Returns:
Indicates whether a request of type 'get' or 'set' has been handled. This includes the obligatory 'result' answer. If you return false, a 'error' will be sent.
Since:
1.0

Implemented in MUCRoom, Disco, Manager, Adhoc, SIProfileFT, Registration, SIManager, RosterManager, SOCKS5BytestreamManager, LastActivity, VCardManager, PrivacyManager, FlexibleOffline, Search, InBandBytestream, PrivateXML, and NonSaslAuth.

virtual void handleIqID ( const IQ iq,
int  context 
) [pure virtual]

Reimplement this function if you want to be notified about incoming IQs with a specific value of the id attribute. You have to enable tracking of those IDs using Client::trackID(). This is usually useful for IDs that generate a positive reply, i.e. <iq type='result' id='reg'/> where a namespace filter wouldn't work.

Parameters:
iqThe complete IQ stanza.
contextA value to restore context, stored with ClientBase::trackID().
Note:
Only IQ stanzas of type 'result' or 'error' can arrive here.
Since:
1.0

Implemented in MUCRoom, Disco, Manager, Adhoc, SIProfileFT, Registration, SIManager, RosterManager, SOCKS5BytestreamManager, LastActivity, VCardManager, PrivacyManager, FlexibleOffline, Search, InBandBytestream, PrivateXML, and NonSaslAuth.


The documentation for this class was generated from the following file: