gloox  1.0.1
Public Types | Public Member Functions | List of all members
IQ Class Reference

#include <iq.h>

Inheritance diagram for IQ:
Inheritance graph

Public Types

enum  IqType {
  Get = 0, Set, Result, Error,

Public Member Functions

 IQ (IqType type, const JID &to, const std::string &id=EmptyString)
virtual ~IQ ()
IqType subtype () const
virtual Tagtag () const
- Public Member Functions inherited from Stanza
virtual ~Stanza ()
void setFrom (const JID &from)
const JIDfrom () const
const JIDto () const
const std::string & id () const
const Errorerror () const
const std::string & xmlLang () const
void addExtension (const StanzaExtension *se)
const StanzaExtensionfindExtension (int type) const
template<class T >
const T * findExtension (int type) const
const StanzaExtensionListextensions () const
void removeExtensions ()

Additional Inherited Members

- Protected Member Functions inherited from Stanza
 Stanza (Tag *tag)
 Stanza (const JID &to)

Detailed Description

An abstraction of an IQ stanza.

Vincent Thomasset
Jakob Schroeter

Definition at line 33 of file iq.h.

Member Enumeration Documentation

enum IqType

Describes the different valid IQ types.


The stanza is a request for information or requirements.


The stanza provides required data, sets new values, or replaces existing values.


The stanza is a response to a successful get or set request.


An error has occurred regarding processing or delivery of a previously-sent get or set (see Stanza Errors (Section 9.3)).


The stanza is invalid

Definition at line 43 of file iq.h.

Constructor & Destructor Documentation

IQ ( IqType  type,
const JID to,
const std::string &  id = EmptyString 

Creates an IQ Query.

typeThe desired IqType.
toThe intended receiver.
idThe request's ID. Usually obtained from ClientBase::getID(). Optional, will be added by ClientBase if the IQ is sent by means of send( IQ&, IqHandler*, int, bool ) . You should only need to pass this when creating a reply (i.e. an IQ of type Result or Error).

Definition at line 38 of file iq.cpp.

~IQ ( )

Virtual destructor.

Definition at line 44 of file iq.cpp.

Member Function Documentation

IqType subtype ( ) const

Returns the IQ's type.

The IQ's type.

Definition at line 74 of file iq.h.

Tag * tag ( ) const

Creates a Tag representation of the Stanza. The Tag is completely independent of the Stanza and will not be updated when the Stanza is modified.

A pointer to a Tag representation. It is the job of the caller to delete the Tag.

Implements Stanza.

Definition at line 48 of file iq.cpp.

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