gloox Namespace Reference

The namespace for the gloox library. More...


Classes

class  Adhoc
 This class implements a provider for JEP-0050 (Ad-hoc Commands). More...
class  AdhocCommandProvider
 A virtual interface for an Ad-hoc Command Provider according to JEP-0050. More...
class  Annotations
 This is an implementation of JEP-0145 (Annotations). More...
class  AnnotationsHandler
 A virtual interface which can be reimplemented to receive notes with help of the Annotations object. More...
class  Base64
 An implementation of the Base64 data encoding (RFC 3548). More...
class  BookmarkHandler
 A virtual interface which can be reimplemented to receive bookmarks with help of a BookmarkStorage object. More...
class  BookmarkStorage
 This is an implementation of JEP-0048 (Bookmark Storage). More...
class  ChatStateFilter
 This class adds Chat State Notifications (JEP-0085) support to a MessageSession. More...
class  ChatStateHandler
 A virtual interface that enables an object to be notified about a remote entity's Chat States (JEP-0085). More...
class  Client
 This class implements a basic Jabber Client. More...
class  ClientBase
 This is the common base class for a jabber Client and a jabber Component. More...
class  Component
 This is an implementation of a basic jabber Component. More...
class  Compression
class  Connection
 This is an implementation of a TLS- and Stream Compression-aware connection handler. More...
class  ConnectionListener
 Derived classes can be registered as ConnectionListeners with the Client. More...
class  DataForm
 An abstraction of a JEP-0004 Data Form. More...
class  DataFormBase
 An abstract base class for a JEP-0004 Data Form. More...
class  DataFormField
 An abstraction of a single field in a JEP-0004 Data Form. More...
class  DataFormItem
 An abstraction of an <item> element in a JEP-0004 Data Form of type result. More...
class  DataFormReported
 An abstraction of an <reported> element in a JEP-0004 Data Form of type result. More...
class  Disco
 This class implements JEP-0030 (Service Discovery) and JEP-0092 (Software Version). More...
class  DiscoHandler
 A virtual interface that enables objects to receive Service Discovery (JEP-0030) events. More...
class  DiscoNodeHandler
 Derived classes can be registered as NodeHandlers for certain nodes with the Disco object. More...
class  DNS
 This class holds a number of static functions used for DNS related stuff. More...
class  FlexibleOffline
 An implementation of JEP-0013 (Flexible Offline Message Retrieval). More...
class  FlexibleOfflineHandler
 Implementation of this virtual interface allows for retrieval of offline messages following JEP-0030. More...
struct  CertInfo
class  InBandBytestream
 An implementation of a single In-Band Bytestream (JEP-0047). More...
class  InBandBytestreamDataHandler
 A virtual interface that allows implementors to receive data sent over a In-Band Bytestream as defined in JEP-0047. More...
class  InBandBytestreamHandler
 A virtual interface that allows to receive new incoming In-Band Bytestream requests from remote entities. More...
class  InBandBytestreamManager
 An InBandBytestreamManager dispatches In-Band Bytestreams. More...
class  IqHandler
 A virtual interface which can be reimplemented to receive IQ stanzas. More...
class  JID
 An abstraction of a JID. More...
class  LastActivity
 This is an implementation of JEP-0012 (Last Activity) for both clients and components. More...
class  LastActivityHandler
 This is an virtual interface that, once reimplemented, allows to receive the results of Last-Activity-queries to other entities. More...
class  LogHandler
 A virtual interface which can be reimplemented to receive debug and log messages. More...
class  LogSink
 An implementation of log sink and source. More...
class  MessageEventFilter
 This class adds Message Event (JEP-0022) support to a MessageSession. More...
class  MessageEventHandler
 A virtual interface that enables an object to be notified about Message Events (JEP-0022). More...
class  MessageFilter
 Virtual base class for message filters. More...
class  MessageHandler
 A virtual interface which can be reimplemented to receive incoming message stanzas. More...
class  MessageSession
 An abstraction of a message session between any two entities. More...
class  MessageSessionHandler
 A virtual interface which can be reimplemented to receive incoming message sessions. More...
class  NonSaslAuth
 This class is an implementation of JEP-0078 (Non-SASL Authentication). More...
class  Parser
 This class is an abstraction of libiksemel's XML parser. More...
class  Prep
 This class offers static functions to stringprep the individual parts of a JID. More...
class  PresenceHandler
 A virtual interface which can be reimplemented to receive presence stanzas. More...
class  PrivacyItem
 This is an abstraction of a single item of a privacy list, describing an allowed or forbidden action. More...
class  PrivacyListHandler
 A virtual interface that allows to retrieve Privacy Lists. More...
class  PrivacyManager
 This class implements a manager for privacy lists as defined in section 10 of RFC 3921. More...
class  PrivateXML
 This class implements JEP-0049 (Private XML Storage). More...
class  PrivateXMLHandler
 A virtual interface which can be reimplemented to store and receive private XML data. More...
class  Registration
 This class is an implementation of JEP-0077 (In-Band Registration). More...
class  RegistrationHandler
 A virtual interface that receives events from an Registration object. More...
class  RosterItem
 An abstraction of a roster item. More...
class  RosterListener
 A virtual interface which can be reimplemented to receive roster updates. More...
class  RosterManager
 This class implements Jabber/XMPP roster handling in the jabber:iq:roster namespace. More...
class  Search
 An implementation of JEP-0055 (Jabber Search). More...
struct  SearchFieldStruct
class  SearchHandler
 A virtual interface that enables objects to receive Jabber Search (JEP-0055) results. More...
class  Stanza
 This is an abstraction of a XMPP stanza. More...
class  SubscriptionHandler
 A virtual interface which can be reimplemented to receive incoming subscription stanzas. More...
class  Tag
 This is an abstraction of an XML element. More...
class  TagHandler
 A virtual interface which can be reimplemented to receive non-XMPP Core stanzas. More...
class  VCard
 A VCard abstraction. More...
class  VCardHandler
 A virtual interface that helps requesting Jabber VCards. More...
class  VCardManager
 A VCardManager can be used to fetch an entities VCard as well as for setting one's own VCard. More...

Typedefs

typedef std::list< std::string > StringList
typedef std::map< std::string,
std::string > 
StringMap
typedef std::list< SearchFieldStructSearchResultList

Enumerations

enum  ConnectionState { StateDisconnected, StateConnecting, StateConnected }
enum  ConnectionError {
  ConnNoError, ConnStreamError, ConnStreamClosed, ConnIoError,
  ConnOutOfMemory, ConnNoSupportedAuth, ConnTlsFailed, ConnAuthenticationFailed,
  ConnUserDisconnected, ConnNotConnected
}
enum  StreamFeature {
  StreamFeatureBind = 1, StreamFeatureSession = 2, StreamFeatureSaslDigestMd5 = 4, StreamFeatureSaslPlain = 8,
  StreamFeatureSaslAnonymous = 16, StreamFeatureSaslExternal = 32, StreamFeatureStartTls = 64, StreamFeatureIqRegister = 128,
  StreamFeatureIqAuth = 256, StreamFeatureAck = 512, StreamFeatureCompressZlib = 1024, StreamFeatureCompressDclz = 2048
}
enum  StreamError {
  StreamErrorUndefined, StreamErrorBadFormat, StreamErrorBadNamespacePrefix, StreamErrorConflict,
  StreamErrorConnectionTimeout, StreamErrorHostGone, StreamErrorHostUnknown, StreamErrorImproperAddressing,
  StreamErrorInternalServerError, StreamErrorInvalidFrom, StreamErrorInvalidId, StreamErrorInvalidNamespace,
  StreamErrorInvalidXml, StreamErrorNotAuthorized, StreamErrorPolicyViolation, StreamErrorRemoteConnectionFailed,
  StreamErrorResourceConstraint, StreamErrorRestrictedXml, StreamErrorSeeOtherHost, StreamErrorSystemShutdown,
  StreamErrorUndefinedCondition, StreamErrorUnsupportedEncoding, StreamErrorUnsupportedStanzaType, StreamErrorUnsupportedVersion,
  StreamErrorXmlNotWellFormed
}
enum  StanzaType {
  StanzaUndefined, StanzaIq, StanzaMessage, StanzaS10n,
  StanzaPresence
}
enum  StanzaSubType {
  StanzaSubUndefined, StanzaIqGet, StanzaIqSet, StanzaIqResult,
  StanzaIqError, StanzaPresenceUnavailable, StanzaPresenceAvailable, StanzaPresenceProbe,
  StanzaPresenceError, StanzaS10nSubscribe, StanzaS10nSubscribed, StanzaS10nUnsubscribe,
  StanzaS10nUnsubscribed, StanzaMessageChat, StanzaMessageError, StanzaMessageGroupchat,
  StanzaMessageHeadline, StanzaMessageNormal
}
enum  StanzaErrorType {
  StanzaErrorTypeUndefined, StanzaErrorTypeCancel, StanzaErrorTypeContinue, StanzaErrorTypeModify,
  StanzaErrorTypeAuth, StanzaErrorTypeWait
}
enum  StanzaError {
  StanzaErrorUndefined = 0, StanzaErrorBadRequest, StanzaErrorConflict, StanzaErrorFeatureNotImplemented,
  StanzaErrorForbidden, StanzaErrorGone, StanzaErrorInternalServerError, StanzaErrorItemNotFound,
  StanzaErrorJidMalformed, StanzaErrorNotAcceptable, StanzaErrorNotAllowed, StanzaErrorNotAuthorized,
  StanzaErrorPaymentRequired, StanzaErrorRecipientUnavailable, StanzaErrorRedirect, StanzaErrorRegistrationRequired,
  StanzaErrorRemoteServerNotFound, StanzaErrorRemoteServerTimeout, StanzaErrorResourceConstraint, StanzaErrorServiceUnavailable,
  StanzaErrorSubscribtionRequired, StanzaErrorUndefinedCondition, StanzaErrorUnexpectedRequest
}
enum  Presence {
  PresenceUnknown, PresenceAvailable, PresenceChat, PresenceAway,
  PresenceDnd, PresenceXa, PresenceUnavailable
}
enum  CertStatus {
  CertOk = 0, CertInvalid = 1, CertSignerUnknown = 2, CertRevoked = 4,
  CertExpired = 8, CertNotActive = 16, CertWrongPeer = 32, CertSignerNotCa = 64
}
enum  AuthenticationError {
  AuthErrorUndefined, SaslAborted, SaslIncorrectEncoding, SaslInvalidAuthzid,
  SaslInvalidMechanism, SaslMechanismTooWeak, SaslNotAuthorized, SaslTemporaryAuthFailure,
  NonSaslConflict, NonSaslNotAcceptable, NonSaslNotAuthorized
}
enum  LogArea {
  LogAreaClassParser = 0x00001, LogAreaClassConnection = 0x00002, LogAreaClassClient = 0x00004, LogAreaClassClientbase = 0x00008,
  LogAreaClassComponent = 0x00010, LogAreaClassDns = 0x00020, LogAreaAllClasses = 0x01FFF, LogAreaXmlIncoming = 0x02000,
  LogAreaXmlOutgoing = 0x04000, LogAreaUser = 0x80000, LogAreaAll = 0xFFFFF
}
enum  LogLevel { LogLevelDebug, LogLevelWarning, LogLevelError }
enum  MessageEventType {
  MessageEventCancel = 0, MessageEventOffline = 1, MessageEventDelivered = 2, MessageEventDisplayed = 4,
  MessageEventComposing = 8
}
enum  ChatStateType {
  ChatStateActive = 1, ChatStateComposing = 2, ChatStatePaused = 4, ChatStateInactive = 8,
  ChatStateGone = 16
}
enum  ResourceBindError { RbErrorUnknownError, RbErrorBadRequest, RbErrorNotAllowed, RbErrorConflict }
enum  SessionCreateError { ScErrorUnknownError, ScErrorInternalServerError, ScErrorForbidden, ScErrorConflict }
enum  MessageSessionFilter { FilterMessageEvents = 1, FilterChatStates = 2 }
enum  SearchFieldEnum

Functions

int tagHook (Parser *parser, char *name, char **atts, int type)
int cdataHook (Parser *parser, char *data, size_t len)

Variables

const std::string XMLNS_CLIENT = "jabber:client"
const std::string XMLNS_COMPONENT_ACCEPT = "jabber:component:accept"
const std::string XMLNS_COMPONENT_CONNECT = "jabber:component:connect"
const std::string XMLNS_DISCO_INFO = "http://jabber.org/protocol/disco#info"
const std::string XMLNS_DISCO_ITEMS = "http://jabber.org/protocol/disco#items"
const std::string XMLNS_ADHOC_COMMANDS = "http://jabber.org/protocol/commands"
const std::string XMLNS_COMPRESSION = "http://jabber.org/protocol/compress"
const std::string XMLNS_OFFLINE = "http://jabber.org/protocol/offline"
const std::string XMLNS_CHAT_STATES = "http://jabber.org/protocol/chatstates"
const std::string XMLNS_AMP = "http://jabber.org/protocol/amp"
const std::string XMLNS_IBB = "http://jabber.org/protocol/ibb"
const std::string XMLNS_CHATNEG = "http://jabber.org/protocol/chatneg"
const std::string XMLNS_XHTML_IM = "http://jabber.org/protocol/xhtml-im"
const std::string XMLNS_ROSTER = "jabber:iq:roster"
const std::string XMLNS_VERSION = "jabber:iq:version"
const std::string XMLNS_REGISTER = "jabber:iq:register"
const std::string XMLNS_PRIVACY = "jabber:iq:privacy"
const std::string XMLNS_AUTH = "jabber:iq:auth"
const std::string XMLNS_PRIVATE_XML = "jabber:iq:private"
const std::string XMLNS_LAST = "jabber:iq:last"
const std::string XMLNS_SEARCH = "jabber:iq:search"
const std::string XMLNS_X_DATA = "jabber:x:data"
const std::string XMLNS_X_EVENT = "jabber:x:event"
const std::string XMLNS_X_OOB = "jabber:x:oob"
const std::string XMLNS_VCARD_TEMP = "vcard-temp"
const std::string XMLNS_BOOKMARKS = "storage:bookmarks"
const std::string XMLNS_ANNOTATIONS = "storage:rosternotes"
const std::string XMLNS_ROSTER_DELIMITER = "roster:delimiter"
const std::string XMLNS_XMPP_STREAM = "urn:ietf:params:xml:ns:xmpp-streams"
const std::string XMLNS_XMPP_STANZAS = "urn:ietf:params:xml:ns:xmpp-stanzas"
const std::string XMLNS_STREAM_TLS = "urn:ietf:params:xml:ns:xmpp-tls"
const std::string XMLNS_STREAM_SASL = "urn:ietf:params:xml:ns:xmpp-sasl"
const std::string XMLNS_STREAM_BIND = "urn:ietf:params:xml:ns:xmpp-bind"
const std::string XMLNS_STREAM_SESSION = "urn:ietf:params:xml:ns:xmpp-session"
const std::string XMLNS_STREAM_IQAUTH = "http://jabber.org/features/iq-auth"
const std::string XMLNS_STREAM_IQREGISTER = "http://jabber.org/features/iq-register"
const std::string XMLNS_STREAM_ACK = "http://jabber.org/features/ack"
const std::string XMLNS_STREAM_COMPRESS = "http://jabber.org/features/compress"
const int XMPP_STREAM_VERSION_MAJOR = 1
const int XMPP_STREAM_VERSION_MINOR = 0
const std::string GLOOX_VERSION = "0.8.8-sic"


Detailed Description

The namespace for the gloox library.

Author:
Jakob Schroeter <js@camaya.net>
Since:
0.3


Typedef Documentation

typedef std::list<SearchFieldStruct> SearchResultList

A list of directory entries returned by a search.

Definition at line 52 of file searchhandler.h.

typedef std::list<std::string> StringList

A list of strings.

Definition at line 846 of file gloox.h.

typedef std::map<std::string, std::string> StringMap

A map of strings.

Definition at line 851 of file gloox.h.


Enumeration Type Documentation

enum AuthenticationError

Describes the defined SASL error conditions.

Enumerator:
AuthErrorUndefined  No error occurred, or error condition is unknown.
SaslAborted  The receiving entity acknowledges an <abort/> element sent by the initiating entity; sent in reply to the <abort/> element.
SaslIncorrectEncoding  The data provided by the initiating entity could not be processed because the [BASE64] encoding is incorrect (e.g., because the encoding does not adhere to the definition in Section 3 of [BASE64]); sent in reply to a <response/> element or an <auth/> element with initial response data.
SaslInvalidAuthzid  The authzid provided by the initiating entity is invalid, either because it is incorrectly formatted or because the initiating entity does not have permissions to authorize that ID; sent in reply to a <response/> element or an <auth/> element with initial response data.
SaslInvalidMechanism  The initiating entity did not provide a mechanism or requested a mechanism that is not supported by the receiving entity; sent in reply to an <auth/> element.
SaslMechanismTooWeak  The mechanism requested by the initiating entity is weaker than server policy permits for that initiating entity; sent in reply to a <response/> element or an <auth/> element with initial response data.
SaslNotAuthorized  The authentication failed because the initiating entity did not provide valid credentials (this includes but is not limited to the case of an unknown username); sent in reply to a <response/> element or an <auth/> element with initial response data.
SaslTemporaryAuthFailure  The authentication failed because of a temporary error condition within the receiving entity; sent in reply to an <auth/> element or <response/> element.
NonSaslConflict  JEP-0078: Resource Conflict
NonSaslNotAcceptable  JEP-0078: Required Information Not Provided
NonSaslNotAuthorized  JEP-0078: Incorrect Credentials

Definition at line 721 of file gloox.h.

enum CertStatus

Describes the verification results of a certificate.

Enumerator:
CertOk  The certificate is valid and trusted.
CertInvalid  The certificate is not trusted.
CertSignerUnknown  The certificate hasn't got a known issuer.
CertRevoked  The certificate has been revoked.
CertExpired  The certificate has expired.
CertNotActive  The certifiacte is not yet active.
CertWrongPeer  The certificate has not been issued for the peer we're connected to.
CertSignerNotCa  The signer is not a CA.

Definition at line 688 of file gloox.h.

enum ChatStateType

The possible Chat States according to JEP-0085.

Enumerator:
ChatStateActive  User is actively participating in the chat session.
ChatStateComposing  User is composing a message.
ChatStatePaused  User had been composing but now has stopped.
ChatStateInactive  User has not been actively participating in the chat session.
ChatStateGone  User has effectively ended their participation in the chat session.

Definition at line 801 of file gloox.h.

enum ConnectionError

This describes connection error conditions.

Enumerator:
ConnNoError  Not really an error. Everything went just fine.
ConnStreamError  A stream error occured. The stream has been closed.
ConnStreamClosed  The stream has been closed graciously.
ConnIoError  An I/O error occured.
ConnOutOfMemory  Out of memory. Uhoh.
ConnNoSupportedAuth  The auth mechanisms the server offers are not supported or the server offered no auth mechanisms at all.
ConnTlsFailed  The server's certificate could not be verified.
ConnAuthenticationFailed  Authentication failed. Username/password wrong or account does not exist.
ConnUserDisconnected  The user (or higher-level protocol) requested a disconnect.
ConnNotConnected  There is no active connection.

Definition at line 358 of file gloox.h.

enum ConnectionState

This describes the possible states of a stream.

Enumerator:
StateDisconnected  The client is in disconnected state.
StateConnecting  The client is currently trying to establish a connection.
StateConnected  The client is connected to the server but authentication is not (yet) done.

Definition at line 347 of file gloox.h.

enum LogArea

Identifies log sources.

Enumerator:
LogAreaClassParser  Log messages from Parser.
LogAreaClassConnection  Log messages from Connection.
LogAreaClassClient  Log messages from Client.
LogAreaClassClientbase  Log messages from ClientBase.
LogAreaClassComponent  Log messages from Component.
LogAreaClassDns  Log messages from DNS.
LogAreaAllClasses  All log messages from all the classes.
LogAreaXmlIncoming  Incoming XML.
LogAreaXmlOutgoing  Outgoing XML.
LogAreaUser  User-defined sources.
LogAreaAll  All log sources.

Definition at line 759 of file gloox.h.

enum LogLevel

Describes a log message's severity.

Enumerator:
LogLevelDebug  Debug messages.
LogLevelWarning  Non-crititcal warning messages.
LogLevelError  Critical, unrecoverable errors.

Definition at line 777 of file gloox.h.

enum MessageEventType

The possible Message Events according to JEP-0022.

Enumerator:
MessageEventCancel  Cancels the 'Composing' event.
MessageEventOffline  Indicates that the message has been stored offline by the intended recipient's server.
MessageEventDelivered  Indicates that the message has been delivered to the recipient.
MessageEventDisplayed  Indicates that the message has been displayed
MessageEventComposing  Indicates that a reply is being composed.

Definition at line 787 of file gloox.h.

enum MessageSessionFilter

Currently implemented message session filters.

Enumerator:
FilterMessageEvents  Message Events (JEP-0022)
FilterChatStates  Chat State Notifications (JEP-0085)

Definition at line 837 of file gloox.h.

enum Presence

Describes the possible 'available presence' types.

Enumerator:
PresenceUnknown  Unknown status.
PresenceAvailable  The entity or resource is online and available.
PresenceChat  The entity or resource is actively interested in chatting.
PresenceAway  The entity or resource is temporarily away.
PresenceDnd  The entity or resource is busy (dnd = "Do Not Disturb").
PresenceXa  The entity or resource is away for an extended period (xa = "eXtended Away").
PresenceUnavailable  The entity or resource if offline.

Definition at line 673 of file gloox.h.

enum ResourceBindError

Describes the possible error conditions for resource binding.

Enumerator:
RbErrorUnknownError  An unknown error occured.
RbErrorBadRequest  Resource identifier cannot be processed.
RbErrorNotAllowed  Client is not allowed to bind a resource.
RbErrorConflict  Resource identifier is in use.

Definition at line 814 of file gloox.h.

enum SearchFieldEnum

The possible fields of a JEP-0055 user search.

Definition at line 41 of file searchhandler.h.

enum SessionCreateError

Describes the possible error conditions for session establishemnt.

Enumerator:
ScErrorUnknownError  An unknown error occured.
ScErrorInternalServerError  Internal server error.
ScErrorForbidden  Username or resource not allowed to create session.
ScErrorConflict  Server informs newly-requested session of resource conflict.

Definition at line 825 of file gloox.h.

enum StanzaError

Describes the defined stanza error conditions of RFC 3920.

Enumerator:
StanzaErrorUndefined  No stanza error occured.
StanzaErrorBadRequest  The sender has sent XML that is malformed or that cannot be processed (e.g., an IQ stanza that includes an unrecognized value of the 'type' attribute); the associated error type SHOULD be "modify".
StanzaErrorConflict  Access cannot be granted because an existing resource or session exists with the same name or address; the associated error type SHOULD be "cancel".
StanzaErrorFeatureNotImplemented  The feature requested is not implemented by the recipient or server and therefore cannot be processed; the associated error type SHOULD be "cancel".
StanzaErrorForbidden  The requesting entity does not possess the required permissions to perform the action; the associated error type SHOULD be "auth".
StanzaErrorGone  The recipient or server can no longer be contacted at this address (the error stanza MAY contain a new address in the XML character data of the <gone/> element); the associated error type SHOULD be "modify".
StanzaErrorInternalServerError  The server could not process the stanza because of a misconfiguration or an otherwise-undefined internal server error; the associated error type SHOULD be "wait".
StanzaErrorItemNotFound  The addressed JID or item requested cannot be found; the associated error type SHOULD be "cancel".
StanzaErrorJidMalformed  The sending entity has provided or communicated an XMPP address (e.g., a value of the 'to' attribute) or aspect thereof (e.g., a resource identifier) that does not adhere to the syntax defined in Addressing Scheme (Section 3); the associated error type SHOULD be "modify".
StanzaErrorNotAcceptable  The recipient or server understands the request but is refusing to process it because it does not meet criteria defined by the recipient or server (e.g., a local policy regarding acceptable words in messages); the associated error type SHOULD be "modify".
StanzaErrorNotAllowed  The recipient or server does not allow any entity to perform the action; the associated error type SHOULD be "cancel".
StanzaErrorNotAuthorized  The sender must provide proper credentials before being allowed to perform the action, or has provided improper credentials; the associated error type SHOULD be "auth".
StanzaErrorPaymentRequired  The requesting entity is not authorized to access the requested service because payment is required; the associated error type SHOULD be "auth".
StanzaErrorRecipientUnavailable  The intended recipient is temporarily unavailable; the associated error type SHOULD be "wait" (note: an application MUST NOT return this error if doing so would provide information about the intended recipient's network availability to an entity that is not authorized to know such information).
StanzaErrorRedirect  The recipient or server is redirecting requests for this information to another entity, usually temporarily (the error stanza SHOULD contain the alternate address, which MUST be a valid JID, in the XML character data of the <redirect/> element); the associated error type SHOULD be "modify".
StanzaErrorRegistrationRequired  The requesting entity is not authorized to access the requested service because registration is required; the associated error type SHOULD be "auth".
StanzaErrorRemoteServerNotFound  A remote server or service specified as part or all of the JID of the intended recipient does not exist; the associated error type SHOULD be "cancel".
StanzaErrorRemoteServerTimeout  A remote server or service specified as part or all of the JID of the intended recipient (or required to fulfill a request) could not be contacted within a reasonable amount of time; the associated error type SHOULD be "wait".
StanzaErrorResourceConstraint  The server or recipient lacks the system resources necessary to service the request; the associated error type SHOULD be "wait".
StanzaErrorServiceUnavailable  The server or recipient does not currently provide the requested service; the associated error type SHOULD be "cancel".
StanzaErrorSubscribtionRequired  The requesting entity is not authorized to access the requested service because a subscription is required; the associated error type SHOULD be "auth".
StanzaErrorUndefinedCondition  The error condition is not one of those defined by the other conditions in this list; any error type may be associated with this condition, and it SHOULD be used only in conjunction with an application-specific condition.
StanzaErrorUnexpectedRequest  The recipient or server understood the request but was not expecting it at this time (e.g., the request was out of order); the associated error type SHOULD be "wait".

Definition at line 593 of file gloox.h.

enum StanzaErrorType

Describes types of stanza errors.

Enumerator:
StanzaErrorTypeUndefined  No error.
StanzaErrorTypeCancel  Do not retry (the error is unrecoverable).
StanzaErrorTypeContinue  Proceed (the condition was only a warning).
StanzaErrorTypeModify  Retry after changing the data sent.
StanzaErrorTypeAuth  Retry after providing credentials.
StanzaErrorTypeWait  Retry after waiting (the error is temporary).

Definition at line 580 of file gloox.h.

enum StanzaSubType

Describes the possible stanza-sub-types.

Enumerator:
StanzaSubUndefined  Undefined.
StanzaIqGet  The stanza is a request for information or requirements.
StanzaIqSet  The stanza provides required data, sets new values, or replaces existing values.
StanzaIqResult  The stanza is a response to a successful get or set request.
StanzaIqError  An error has occurred regarding processing or delivery of a previously-sent get or set (see Stanza Errors (Section 9.3)).
StanzaPresenceUnavailable  Signals that the entity is no longer available for communication.
StanzaPresenceAvailable  Signals to the server that the sender is online and available for communication.
StanzaPresenceProbe  A request for an entity's current presence; SHOULD be generated only by a server on behalf of a user.
StanzaPresenceError  An error has occurred regarding processing or delivery of a previously-sent presence stanza.
StanzaS10nSubscribe  The sender wishes to subscribe to the recipient's presence.
StanzaS10nSubscribed  The sender has allowed the recipient to receive their presence.
StanzaS10nUnsubscribe  The sender is unsubscribing from another entity's presence.
StanzaS10nUnsubscribed  The subscription request has been denied or a previously-granted subscription has been cancelled.
StanzaMessageChat  The message is sent in the context of a one-to-one chat conversation. A compliant client SHOULD present the message in an interface enabling one-to-one chat between the two parties, including an appropriate conversation history.
StanzaMessageError  An error has occurred related to a previous message sent by the sender (for details regarding stanza error syntax, refer to [XMPP-CORE]). A compliant client SHOULD present an appropriate interface informing the sender of the nature of the error.
StanzaMessageGroupchat  The message is sent in the context of a multi-user chat environment (similar to that of [IRC]). A compliant client SHOULD present the message in an interface enabling many-to-many chat between the parties, including a roster of parties in the chatroom and an appropriate conversation history. Full definition of XMPP-based groupchat protocols is out of scope for this memo.
StanzaMessageHeadline  The message is probably generated by an automated service that delivers or broadcasts content (news, sports, market information, RSS feeds, etc.). No reply to the message is expected, and a compliant client SHOULD present the message in an interface that appropriately differentiates the message from standalone messages, chat sessions, or groupchat sessions (e.g., by not providing the recipient with the ability to reply).
StanzaMessageNormal  The message is a single message that is sent outside the context of a one-to-one conversation or groupchat, and to which it is expected that the recipient will reply. A compliant client SHOULD present the message in an interface enabling the recipient to reply, but without a conversation history.

Definition at line 493 of file gloox.h.

enum StanzaType

Describes the possible stanza types.

Enumerator:
StanzaUndefined  Undefined.
StanzaIq  An Info/Query stanza.
StanzaMessage  A message stanza.
StanzaS10n  A presence/subscription stanza.
StanzaPresence  A presence stanza.

Definition at line 481 of file gloox.h.

enum StreamError

This decribes stream error conditions as defined in RFC 3920 Sec. 4.7.3.

Enumerator:
StreamErrorUndefined  An undefined/unknown error occured. Also used if a diconnect was user-initiated. Also set before and during a established connection (where obviously no error occured).
StreamErrorBadFormat  The entity has sent XML that cannot be processed; this error MAY be used instead of the more specific XML-related errors, such as <bad-namespace-prefix/>, <invalid-xml/>, <restricted-xml/>, <unsupported-encoding/>, and <xml-not-well-formed/>, although the more specific errors are preferred.
StreamErrorBadNamespacePrefix  The entity has sent a namespace prefix that is unsupported, or has sent no namespace prefix on an element that requires such a prefix (see XML Namespace Names and Prefixes (Section 11.2)).
StreamErrorConflict  The server is closing the active stream for this entity because a new stream has been initiated that conflicts with the existing stream.
StreamErrorConnectionTimeout  The entity has not generated any traffic over the stream for some period of time (configurable according to a local service policy).
StreamErrorHostGone  the value of the 'to' attribute provided by the initiating entity in the stream header corresponds to a hostname that is no longer hosted by the server.
StreamErrorHostUnknown  The value of the 'to' attribute provided by the initiating entity in the stream header does not correspond to a hostname that is hosted by the server.
StreamErrorImproperAddressing  A stanza sent between two servers lacks a 'to' or 'from' attribute (or the attribute has no value).
StreamErrorInternalServerError  the server has experienced a misconfiguration or an otherwise-undefined internal error that prevents it from servicing the stream.
StreamErrorInvalidFrom  The JID or hostname provided in a 'from' address does not match an authorized JID or validated domain negotiated between servers via SASL or dialback, or between a client and a server via authentication and resource binding.
StreamErrorInvalidId  The stream ID or dialback ID is invalid or does not match an ID previously provided.
StreamErrorInvalidNamespace  The streams namespace name is something other than "http://etherx.jabber.org/streams" or the dialback namespace name is something other than "jabber:server:dialback" (see XML Namespace Names and Prefixes (Section 11.2)).
StreamErrorInvalidXml  The entity has sent invalid XML over the stream to a server that performs validation (see Validation (Section 11.3)).
StreamErrorNotAuthorized  The entity has attempted to send data before the stream has been authenticated, or otherwise is not authorized to perform an action related to stream negotiation; the receiving entity MUST NOT process the offending stanza before sending the stream error.
StreamErrorPolicyViolation  The entity has violated some local service policy; the server MAY choose to specify the policy in the <text/> element or an application-specific condition element.
StreamErrorRemoteConnectionFailed  The server is unable to properly connect to a remote entity that is required for authentication or authorization.
StreamErrorResourceConstraint  the server lacks the system resources necessary to service the stream.
StreamErrorRestrictedXml  The entity has attempted to send restricted XML features such as a comment, processing instruction, DTD, entity reference, or unescaped character (see Restrictions (Section 11.1)).
StreamErrorSeeOtherHost  The server will not provide service to the initiating entity but is redirecting traffic to another host; the server SHOULD specify the alternate hostname or IP address (which MUST be a valid domain identifier) as the XML character data of the <see-other-host/> element.
StreamErrorSystemShutdown  The server is being shut down and all active streams are being closed.
StreamErrorUndefinedCondition  The error condition is not one of those defined by the other conditions in this list; this error condition SHOULD be used only in conjunction with an application-specific condition.
StreamErrorUnsupportedEncoding  The initiating entity has encoded the stream in an encoding that is not supported by the server (see Character Encoding (Section 11.5)).
StreamErrorUnsupportedStanzaType  The initiating entity has sent a first-level child of the stream that is not supported by the server.
StreamErrorUnsupportedVersion  The value of the 'version' attribute provided by the initiating entity in the stream header specifies a version of XMPP that is not supported by the server; the server MAY specify the version(s) it supports in the <text/> element.
StreamErrorXmlNotWellFormed  The initiating entity has sent XML that is not well-formed as defined by [XML].

Definition at line 400 of file gloox.h.

enum StreamFeature

Supported Stream Features.

Enumerator:
StreamFeatureBind  The server supports resource binding.
StreamFeatureSession  The server supports sessions.
StreamFeatureSaslDigestMd5  The server supports SASL DIGEST-MD5 mechanism.
StreamFeatureSaslPlain  The server supports SASL PLAIN mechanism.
StreamFeatureSaslAnonymous  The server supports SASL ANONYMOUS mechanism.
StreamFeatureSaslExternal  The server supports SASL EXTERNAL mechanism.
StreamFeatureStartTls  The server supports <starttls>.
StreamFeatureIqRegister  The server supports JEP-0077 (In-Band Registration).
StreamFeatureIqAuth  The server supports JEP-0078 (Non-SASL Authentication).
StreamFeatureAck  The server supports JEPAck (experimental).
StreamFeatureCompressZlib  The server supports JEP-0138 (Stream Compression) (Zlib)
StreamFeatureCompressDclz  The server supports JEP-0138 (Stream Compression) (LZW/DCLZ)

Definition at line 377 of file gloox.h.


Function Documentation

int cdataHook ( Parser *  parser,
char *  data,
size_t  len 
)

Called by iksemel's parser with cdata for the current node.

Parameters:
parser The current Parser.
data The cdata.
len The length of the data.

Definition at line 126 of file parser.cpp.

int tagHook ( Parser *  parser,
char *  name,
char **  atts,
int  type 
)

Called by iksemel's parser for every new element.

Parameters:
parser The current Parser.
name The element's name.
atts The element's list of attributes.
type The type of the element.

Definition at line 70 of file parser.cpp.


Generated on Tue May 1 14:20:20 2007 for gloox by  doxygen 1.5.1