gloox 1.0
Public Types | Public Member Functions
IQ Class Reference

An abstraction of an IQ stanza. More...

#include <iq.h>

Inheritance diagram for IQ:
Inheritance graph
[legend]

List of all members.

Public Types

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

Public Member Functions

 IQ (IqType type, const JID &to, const std::string &id=EmptyString)
virtual ~IQ ()
IqType subtype () const
virtual Tagtag () const

Detailed Description

An abstraction of an IQ stanza.

Author:
Vincent Thomasset
Jakob Schroeter <js@camaya.net>
Since:
1.0

Definition at line 33 of file iq.h.


Member Enumeration Documentation

enum IqType

Describes the different valid IQ types.

Enumerator:
Get 

The stanza is a request for information or requirements.

Set 

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

Result 

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

Error 

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

Invalid 

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.

Parameters:
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]

Virtual destructor.

Definition at line 44 of file iq.cpp.


Member Function Documentation

IqType subtype ( ) const [inline]

Returns the IQ's type.

Returns:
The IQ's type.

Definition at line 74 of file iq.h.

Tag * tag ( ) const [virtual]

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.

Returns:
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: