gloox Namespace Reference

The namespace for the gloox library. More...


Classes

class  Adhoc
 This class implements a provider for XEP-0050 (Ad-hoc Commands). More...
class  AdhocCommandProvider
 A virtual interface for an Ad-hoc Command Provider according to XEP-0050. More...
class  AdhocHandler
 A virtual interface for an Ad-hoc Command users according to XEP-0050. More...
class  Annotations
 This is an implementation of XEP-0145 (Annotations). More...
struct  AnnotationsListItem
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...
struct  BookmarkListItem
struct  ConferenceListItem
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 XEP-0048 (Bookmark Storage). More...
class  ChatStateFilter
 This class adds Chat State Notifications (XEP-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 (XEP-0085). More...
class  Client
 This class implements a basic Jabber Client. More...
class  ClientBase
 This is the common base class for a Jabber/XMPP Client and a jabber Component. More...
class  Component
 This is an implementation of a basic jabber Component. More...
class  CompressionBase
 This is an abstract base class for stream compression implementations. More...
class  CompressionDataHandler
 An abstract base class used to receive de/compressed data from a CompressionBase-derived object. More...
class  CompressionZlib
class  ConnectionBase
 An abstract base class for a connection. More...
class  ConnectionDataHandler
 This is an abstract base class to receive events from a ConnectionBase-derived object. More...
class  ConnectionHandler
 This is an abstract base class to receive incoming connection attempts. Do not confuse this with ConnectionListener, which is used with XMPP streams and has a completely different meaning. More...
class  ConnectionHTTPProxy
 This is an implementation of a simple HTTP Proxying connection. More...
class  ConnectionListener
 Derived classes can be registered as ConnectionListeners with the Client. More...
class  ConnectionSOCKS5Proxy
 This is an implementation of a simple SOCKS5 Proxying connection (RFC 1928 + RFC 1929). More...
class  ConnectionTCPBase
 This is a base class for a simple TCP connection. More...
class  ConnectionTCPClient
 This is an implementation of a simple TCP connection. More...
class  ConnectionTCPServer
 This is an implementation of a simple listening TCP connection. More...
class  DataForm
 An abstraction of a XEP-0004 Data Form. More...
class  DataFormBase
 An abstract base class for a XEP-0004 Data Form. More...
class  DataFormField
 An abstraction of a single field in a XEP-0004 Data Form. More...
class  DataFormItem
 An abstraction of an <item> element in a XEP-0004 Data Form of type result. More...
class  DataFormReported
 An abstraction of an <reported> element in a XEP-0004 Data Form of type result. More...
class  DelayedDelivery
 This is an implementation of XEP-0203 (Delayed Delivery). More...
class  Disco
 This class implements XEP-0030 (Service Discovery) and XEP-0092 (Software Version). More...
class  DiscoHandler
 A virtual interface that enables objects to receive Service Discovery (XEP-0030) events. More...
struct  DiscoNodeItem
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 XEP-0013 (Flexible Offline Message Retrieval). More...
class  FlexibleOfflineHandler
 Implementation of this virtual interface allows for retrieval of offline messages following XEP-0030. More...
struct  CertInfo
class  GPGEncrypted
 This is an abstraction of a jabber:x:encrypted namespace element, as used in XEP-0027 (Current Jabber OpenPGP Usage). More...
class  GPGSigned
 This is an abstraction of a jabber:x:signed namespace element, as used in XEP-0027 (Current Jabber OpenPGP Usage). More...
class  InBandBytestream
 An implementation of a single In-Band Bytestream (XEP-0047). More...
class  InBandBytestreamDataHandler
 A virtual interface that allows implementors to receive data sent over a In-Band Bytestream as defined in XEP-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  InstantMUCRoom
 This class implements an instant MUC room. 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 XEP-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  MD5
 An MD% implementation. More...
class  MessageEventFilter
 This class adds Message Event (XEP-0022) support to a MessageSession. More...
class  MessageEventHandler
 A virtual interface that enables an object to be notified about Message Events (XEP-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  MUCInvitationHandler
class  MUCMessageSession
 This is a MessageSession, adapted to be used in a MUC context. More...
class  MUCRoom
 This is an implementation of XEP-0045 (Multi-User Chat). More...
struct  MUCListItem
class  MUCRoomConfigHandler
struct  MUCRoomParticipant
class  MUCRoomHandler
 This interface enables inheriting classes to be notified about certain events in a MUC room. More...
class  Mutex
 A simple implementation of mutex as a wrapper around a pthread mutex or a win32 critical section. More...
class  MutexGuard
 A simple implementation of a mutex guard. More...
class  NonSaslAuth
 This class is an implementation of XEP-0078 (Non-SASL Authentication). More...
class  OOB
 This is an abstraction of a jabber:x:oob namespace element or a jabber:iq:oob namespace element as specified in XEP-0066. More...
class  Parser
 This class implements an XML parser. 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 XEP-0049 (Private XML Storage). More...
class  PrivateXMLHandler
 A virtual interface which can be reimplemented to store and receive private XML data. More...
struct  RegistrationFields
class  Registration
 This class is an implementation of XEP-0077 (In-Band Registration). More...
class  RegistrationHandler
 A virtual interface that receives events from an Registration object. More...
class  Resource
 Holds resource attributes. 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 XEP-0055 (Jabber Search). More...
struct  SearchFieldStruct
class  SearchHandler
 A virtual interface that enables objects to receive Jabber Search (XEP-0055) results. More...
class  SHA
 An implementation of SHA1. More...
class  SIHandler
 An abstract base class to handle results of outgoing SI requests, i.e. you requested a stream (using SIManager::requestSI()) to send a file to a remote entity. More...
class  SIManager
 This class manages streams initiated using XEP-0095. More...
class  SIProfileFT
 An implementation of the file transfer SI profile (XEP-0096). More...
class  SIProfileFTHandler
 An abstract base class to handle file transfer (FT) requests. More...
class  SIProfileHandler
 An abstract base class to handle SI requests for a specific profile, e.g. file transfer. More...
class  SOCKS5Bytestream
 An implementation of a single SOCKS5 Bytestream (XEP-0065). More...
class  SOCKS5BytestreamDataHandler
 A virtual interface that allows implementors to receive data sent over a SOCKS5 Bytestream as defined in XEP-0066. You'll also need it for sending of data. More...
class  SOCKS5BytestreamHandler
 A virtual interface that allows to receive new incoming SOCKS5 Bytestream requests from remote entities. More...
struct  StreamHost
class  SOCKS5BytestreamManager
 An SOCKS5BytestreamManager dispatches SOCKS5 Bytestreams. More...
class  SOCKS5BytestreamServer
 A server listening for SOCKS5 bytestreams. More...
class  Stanza
 This is an abstraction of a XMPP stanza. More...
class  StanzaExtension
 This class abstracts a stanza extension, which is usually (but not necessarily) an 'x' element in a specific namespace. More...
class  StanzaExtensionFactory
 A Factory that creates StanzaExtensions from Tags. More...
struct  StatisticsStruct
class  StatisticsHandler
 A virtual interface which can be reimplemented to receive connection statistics. 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  TLSBase
 An abstract base class for TLS implementations. More...
class  TLSDefault
 This is an abstraction of the various TLS implementations. More...
class  GnuTLSBase
 This is the common base class for (stream) encryption using GnuTLS. More...
class  GnuTLSClient
 This class implements a TLS backend using GnuTLS. More...
class  GnuTLSClientAnon
 This class implements an anonymous TLS backend using GnuTLS. More...
class  GnuTLSServerAnon
 This class implements (stream) encryption using GnuTLS server-side. More...
class  TLSHandler
 An interface that allows for interacting with TLS implementations derived from TLSBase. More...
class  OpenSSL
class  SChannel
class  UniqueMUCRoom
 This class implements a unique MUC room. 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...
class  VCardUpdate
 This is an abstraction of a vcard-temp:x:update namespace element, as used in XEP-0153 (vCard-Based Avatars). More...
class  XDelayedDelivery
 This is an implementation of XEP-0091 (Delayed Delivery). More...

Namespaces

namespace  prep

Typedefs

typedef std::list
< AnnotationsListItem
AnnotationsList
typedef std::list
< BookmarkListItem
BookmarkList
typedef std::list
< ConferenceListItem
ConferenceList
typedef std::list< DiscoNodeItemDiscoNodeItemList
typedef std::list< std::string > StringList
typedef std::map< std::string,
std::string > 
StringMap
typedef std::list< MUCListItemMUCListItemList
typedef std::map< const
std::string, RosterItem * > 
Roster
typedef std::list
< SearchFieldStruct
SearchResultList
typedef std::list< StreamHostStreamHostList
typedef std::list
< StanzaExtension * > 
StanzaExtensionList

Enumerations

enum  FlexibleOfflineResult {
  FomrRemoveSuccess, FomrRequestSuccess, FomrForbidden, FomrItemNotFound,
  FomrUnknownError
}
enum  ConnectionState { StateDisconnected, StateConnecting, StateConnected }
enum  StreamEvent {
  StreamEventConnecting, StreamEventEncryption, StreamEventCompression, StreamEventAuthentication,
  StreamEventSessionInit, StreamEventResourceBinding, StreamEventSessionCreation, StreamEventRoster,
  StreamEventFinished
}
enum  ConnectionError {
  ConnNoError, ConnStreamError, ConnStreamVersionError, ConnStreamClosed,
  ConnProxyAuthRequired, ConnProxyAuthFailed, ConnProxyNoSupportedAuth, ConnIoError,
  ConnParseError, ConnConnectionRefused, ConnDnsError, ConnOutOfMemory,
  ConnNoSupportedAuth, ConnTlsFailed, ConnTlsNotAvailable, ConnCompressionFailed,
  ConnAuthenticationFailed, ConnUserDisconnected, ConnNotConnected
}
enum  TLSPolicy { TLSDisabled, TLSOptional, TLSRequired }
enum  StreamFeature {
  StreamFeatureBind = 1, StreamFeatureSession = 2, StreamFeatureStartTls = 8, StreamFeatureIqRegister = 16,
  StreamFeatureIqAuth = 32, StreamFeatureCompressZlib = 64, StreamFeatureCompressDclz = 128
}
enum  SaslMechanism {
  SaslMechNone = 0, SaslMechDigestMd5 = 256, SaslMechPlain = 512, SaslMechAnonymous = 1024,
  SaslMechExternal = 2048, SaslMechGssapi = 4096, SaslMechAll = 65535
}
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 = 0, StanzaIqGet = 1, StanzaIqSet = 2, StanzaIqResult = 4,
  StanzaIqError = 8, StanzaPresenceUnavailable = 16, StanzaPresenceAvailable = 32, StanzaPresenceProbe = 64,
  StanzaPresenceError = 128, StanzaS10nSubscribe = 256, StanzaS10nSubscribed = 512, StanzaS10nUnsubscribe = 1024,
  StanzaS10nUnsubscribed = 2048, StanzaMessageChat = 4096, StanzaMessageError = 8192, StanzaMessageGroupchat = 16384,
  StanzaMessageHeadline = 32768, StanzaMessageNormal = 65536
}
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, LogAreaClassConnectionTCPBase = 0x00002, LogAreaClassClient = 0x00004, LogAreaClassClientbase = 0x00008,
  LogAreaClassComponent = 0x00010, LogAreaClassDns = 0x00020, LogAreaClassConnectionHTTPProxy = 0x00040, LogAreaClassConnectionSOCKS5Proxy = 0x00080,
  LogAreaClassConnectionTCPClient = 0x00100, LogAreaClassConnectionTCPServer = 0x00200, LogAreaClassS5BManager = 0x00400, 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  MUCRoomAffiliation {
  AffiliationNone, AffiliationOutcast, AffiliationMember, AffiliationOwner,
  AffiliationAdmin
}
enum  MUCRoomRole { RoleNone, RoleVisitor, RoleParticipant, RoleModerator }
enum  MUCRoomFlag {
  FlagPasswordProtected = 1, FlagPublicLogging = 2, FlagHidden = 4, FlagMembersOnly = 8,
  FlagModerated = 16, FlagNonAnonymous = 32, FlagOpen = 64, FlagPersistent = 128,
  FlagPublic = 256, FlagSemiAnonymous = 512, FlagTemporary = 1024, FlagUnmoderated = 2048,
  FlagUnsecured = 4096, FlagFullyAnonymous = 8192
}
enum  MUCUserFlag {
  UserSelf = 1, UserNickChanged = 2, UserKicked = 4, UserBanned = 8,
  UserAffiliationChanged = 16, UserRoomDestroyed = 32
}
enum  MUCOperation {
  RequestUniqueName, CreateInstantRoom, CancelRoomCreation, RequestRoomConfig,
  DestroyRoom, GetRoomInfo, GetRoomItems, SetRNone,
  SetVisitor, SetParticipant, SetModerator, SetANone,
  SetOutcast, SetMember, SetAdmin, SetOwner,
  RequestVoiceList, StoreVoiceList, RequestBanList, StoreBanList,
  RequestMemberList, StoreMemberList, RequestModeratorList, StoreModeratorList,
  RequestOwnerList, StoreOwnerList, RequestAdminList, StoreAdminList
}
enum  PrivacyListResult {
  ResultStoreSuccess, ResultActivateSuccess, ResultDefaultSuccess, ResultRemoveSuccess,
  ResultRequestNamesSuccess, ResultRequestListSuccess, ResultConflict, ResultItemNotFound,
  ResultBadRequest, ResultUnknownError
}
enum  RegistrationResult {
  RegistrationSuccess = 0, RegistrationNotAcceptable, RegistrationConflict, RegistrationNotAuthorized,
  RegistrationBadRequest, RegistrationForbidden, RegistrationRequired, RegistrationUnexpectedRequest,
  RegistrationNotAllowed, RegistrationUnknownError
}
enum  SearchFieldEnum { SearchFieldFirst = 1, SearchFieldLast = 2, SearchFieldNick = 4, SearchFieldEmail = 8 }
enum  StanzaExtensionType {
  ExtNone = 1, ExtVCardUpdate = 2, ExtOOB = 4, ExtGPGSigned = 8,
  ExtGPGEncrypted = 16, ExtXDelay = 32, ExtDelay = 64
}

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_FEATURE_NEG = "http://jabber.org/protocol/feature-neg"
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_DELAY = "urn:xmpp:delay"
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_IQ_OOB = "jabber:iq:oob"
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_X_DELAY = "jabber:x:delay"
const std::string XMLNS_X_GPGSIGNED = "jabber:x:signed"
const std::string XMLNS_X_GPGENCRYPTED = "jabber:x:encrypted"
const std::string XMLNS_VCARD_TEMP = "vcard-temp"
const std::string XMLNS_X_VCARD_UPDATE = "vcard-temp:x:update"
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_PING = "urn:xmpp:ping"
const std::string XMLNS_SI = "http://jabber.org/protocol/si"
const std::string XMLNS_SI_FT = "http://jabber.org/protocol/si/profile/file-transfer"
const std::string XMLNS_BYTESTREAMS = "http://jabber.org/protocol/bytestreams"
const std::string XMLNS_MUC = "http://jabber.org/protocol/muc"
const std::string XMLNS_MUC_USER = "http://jabber.org/protocol/muc#user"
const std::string XMLNS_MUC_ADMIN = "http://jabber.org/protocol/muc#admin"
const std::string XMLNS_MUC_UNIQUE = "http://jabber.org/protocol/muc#unique"
const std::string XMLNS_MUC_OWNER = "http://jabber.org/protocol/muc#owner"
const std::string XMLNS_MUC_ROOMINFO = "http://jabber.org/protocol/muc#roominfo"
const std::string XMLNS_MUC_ROOMS = "http://jabber.org/protocol/muc#rooms"
const std::string XMLNS_MUC_REQUEST = "http://jabber.org/protocol/muc#request"
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_COMPRESS = "http://jabber.org/features/compress"
const std::string XMPP_STREAM_VERSION_MAJOR = "1"
const std::string XMPP_STREAM_VERSION_MINOR = "0"
const std::string GLOOX_VERSION = "0.9.9.5"


Detailed Description

The namespace for the gloox library.

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

Typedef Documentation

A list of note items.

Definition at line 40 of file annotationshandler.h.

typedef std::list<BookmarkListItem> BookmarkList

A list of URL items.

Definition at line 48 of file bookmarkhandler.h.

typedef std::list<ConferenceListItem> ConferenceList

A list of conference items.

Definition at line 53 of file bookmarkhandler.h.

typedef std::list<DiscoNodeItem> DiscoNodeItemList

A list of DiscoNodeItems.

Definition at line 45 of file disconodehandler.h.

typedef std::list<MUCListItem> MUCListItemList

A list of MUCListItems.

Definition at line 47 of file mucroomconfighandler.h.

typedef std::map<const std::string, RosterItem*> Roster

A map of JID/RosterItem pairs.

Definition at line 25 of file rosterlistener.h.

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<StanzaExtension*> StanzaExtensionList

A list of StanzaExtensions.

Definition at line 24 of file stanza.h.

typedef std::list<StreamHost> StreamHostList

A list of StreamHosts.

Definition at line 42 of file socks5bytestreammanager.h.

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

A list of strings.

Definition at line 1151 of file gloox.h.

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

A map of strings.

Definition at line 1156 of file gloox.h.


Enumeration Type Documentation

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  XEP-0078: Resource Conflict
NonSaslNotAcceptable  XEP-0078: Required Information Not Provided
NonSaslNotAuthorized  XEP-0078: Incorrect Credentials

Definition at line 964 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 929 of file gloox.h.

The possible Chat States according to XEP-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 1049 of file gloox.h.

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. Use ClientBase::streamError() to find the reason.
ConnStreamVersionError  The incoming stream's version is not supported
ConnStreamClosed  The stream has been closed (by the server).
ConnProxyAuthRequired  The HTTP/SOCKS5 proxy requires authentication.
Since:
0.9
ConnProxyAuthFailed  HTTP/SOCKS5 proxy authentication failed.
Since:
0.9
ConnProxyNoSupportedAuth  The HTTP/SOCKS5 proxy requires an unsupported auth mechanism.
Since:
0.9
ConnIoError  An I/O error occured.
ConnParseError  An XML parse error occurred.
ConnConnectionRefused  The connection was refused by the server (on the socket level).
Since:
0.9
ConnDnsError  Resolving the server's hostname failed.
Since:
0.9
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 or the TLS handshake did not complete successfully.
ConnTlsNotAvailable  The server didn't offer TLS while it was set to be required or TLS was not compiled in.
Since:
0.9.4
ConnCompressionFailed  Negotiating/initializing compression failed.
Since:
0.9
ConnAuthenticationFailed  Authentication failed. Username/password wrong or account does not exist. Use ClientBase::authError() to find the reason.
ConnUserDisconnected  The user (or higher-level protocol) requested a disconnect.
ConnNotConnected  There is no active connection.

Definition at line 555 of file gloox.h.

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 526 of file gloox.h.

Describes the possible results of a message retrieval or deletion request.

Enumerator:
FomrRemoveSuccess  Message(s) were removed successfully.
FomrRequestSuccess  Message(s) were fetched successfully.
FomrForbidden  The requester is a JID other than an authorized resource of the user. Something wnet serieously wrong
FomrItemNotFound  The requested node (message ID) does not exist.
FomrUnknownError  An error occurred which is not specified in XEP-0013.

Definition at line 25 of file flexoffhandler.h.

enum LogArea

Identifies log sources.

Enumerator:
LogAreaClassParser  Log messages from Parser.
LogAreaClassConnectionTCPBase  Log messages from ConnectionTCPBase.
LogAreaClassClient  Log messages from Client.
LogAreaClassClientbase  Log messages from ClientBase.
LogAreaClassComponent  Log messages from Component.
LogAreaClassDns  Log messages from DNS.
LogAreaClassConnectionHTTPProxy  Log messages from ConnectionHTTPProxy
LogAreaClassConnectionSOCKS5Proxy  Log messages from ConnectionHTTPProxy
LogAreaClassConnectionTCPClient  Log messages from ConnectionTCPClient.
LogAreaClassConnectionTCPServer  Log messages from ConnectionTCPServer.
LogAreaClassS5BManager  Log messages from SOCKS5BytestreamManager.
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 1002 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 1025 of file gloox.h.

The possible Message Events according to XEP-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 1035 of file gloox.h.

Currently implemented message session filters.

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

Definition at line 1085 of file gloox.h.

Available operations on a room.

Enumerator:
RequestUniqueName  Request a unique room name.
CreateInstantRoom  Create an instant room.
CancelRoomCreation  Cancel room creation process.
RequestRoomConfig  Request room configuration form.
DestroyRoom  Destroy room.
GetRoomInfo  Fetch room info.
GetRoomItems  Fetch room items (e.g., current occupants).
SetRNone  Set a user's role to None.
SetVisitor  Set a user's role to Visitor.
SetParticipant  Set a user's role to Participant.
SetModerator  Set a suer's role to Moderator.
SetANone  Set a user's affiliation to None.
SetOutcast  Set a user's affiliation to Outcast.
SetMember  Set a user's affiliation to Member.
SetAdmin  Set a user's affiliation to Admin.
SetOwner  Set a user's affiliation to Owner.
RequestVoiceList  Request the room's Voice List.
StoreVoiceList  Store the room's Voice List.
RequestBanList  Request the room's Ban List.
StoreBanList  Store the room's Ban List.
RequestMemberList  Request the room's Member List.
StoreMemberList  Store the room's Member List.
RequestModeratorList  Request the room's Moderator List.
StoreModeratorList  Store the room's Moderator List.
RequestOwnerList  Request the room's Owner List.
StoreOwnerList  Store the room's Owner List.
RequestAdminList  Request the room's Admin List.
StoreAdminList  Store the room's Admin List.

Definition at line 52 of file mucroomconfighandler.h.

Defined MUC room affiliations. See XEP-0045 for default privileges.

Enumerator:
AffiliationNone  No affiliation with the room.
AffiliationOutcast  The user has been banned from the room.
AffiliationMember  The user is a member of the room.
AffiliationOwner  The user is a room owner.
AffiliationAdmin  The user is a room admin.

Definition at line 1094 of file gloox.h.

Configuration flags for a room.

Enumerator:
FlagPasswordProtected  Password-protected room.
FlagPublicLogging  Room conversation is publicly logged.
FlagHidden  Hidden room.
FlagMembersOnly  Members-only room.
FlagModerated  Moderated room.
FlagNonAnonymous  Non-anonymous room.
FlagOpen  Open room.
FlagPersistent  Persistent room .
FlagPublic  Public room.
FlagSemiAnonymous  Semi-anonymous room.
FlagTemporary  Temporary room.
FlagUnmoderated  Unmoderated room.
FlagUnsecured  Unsecured room.
FlagFullyAnonymous  Fully anonymous room.

Definition at line 1117 of file gloox.h.

Defined MUC room roles. See XEP-0045 for default privileges.

Enumerator:
RoleNone  Not present in room.
RoleVisitor  The user visits a room.
RoleParticipant  The user has voice in a moderatd room.
RoleModerator  The user is a room moderator.

Definition at line 1106 of file gloox.h.

Configuration flags for a user.

Enumerator:
UserSelf  Other flags relate to the current user him/herself.
UserNickChanged  The user changed his/her nickname.
UserKicked  The user has been kicked.
UserBanned  The user has been banned.
UserAffiliationChanged  The user's affiliation with the room changed.
UserRoomDestroyed  The room has been destroyed.

Definition at line 1138 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 is offline.

Definition at line 914 of file gloox.h.

The possible results of an operation on a privacy list.

Enumerator:
ResultStoreSuccess  Storing was successful.
ResultActivateSuccess  Activation was successful.
ResultDefaultSuccess  Setting the default list was successful.
ResultRemoveSuccess  Removing a list was successful.
ResultRequestNamesSuccess  Requesting the list names was successful.
ResultRequestListSuccess  The list was requested successfully.
ResultConflict  A conflict occurred when activating a list or setting the default list.
ResultItemNotFound  The requested list does not exist.
ResultBadRequest  Bad request.
ResultUnknownError  An unknown error occured.

Definition at line 28 of file privacylisthandler.h.

Possible results of a XEP-0077 operation.

Enumerator:
RegistrationSuccess  The last operation (account registration, account deletion or password change) was successful.
RegistrationNotAcceptable  406: Not all necessary information provided
RegistrationConflict  409: Username alreday exists.
RegistrationNotAuthorized  Account removal: Unregistered entity waits too long before authentication or performs tasks other than authentication after registration.
Password change: The server or service does not consider the channel safe enough to enable a password change.
RegistrationBadRequest  Account removal: The <remove/> element was not the only child element of the <query/> element. Should not happen when only gloox functions are being used.
Password change: The password change request does not contain complete information (both <username/> and <password/> are required).
RegistrationForbidden  Account removal: The sender does not have sufficient permissions to cancel the registration.
RegistrationRequired  Account removal: The entity sending the remove request was not previously registered.
RegistrationUnexpectedRequest  Account removal: The host is an instant messaging server and the IQ get does not contain a 'from' address because the entity is not registered with the server.
Password change: The host is an instant messaging server and the IQ set does not contain a 'from' address because the entity is not registered with the server.
RegistrationNotAllowed  Password change: The server or service does not allow password changes.
RegistrationUnknownError  An unknown error condition occured.

Definition at line 32 of file registrationhandler.h.

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 1062 of file gloox.h.

Supported SASL mechanisms.

Enumerator:
SaslMechNone  Invalid SASL Mechanism.
SaslMechDigestMd5  SASL Digest-MD5 according to RFC 2831.
SaslMechPlain  SASL PLAIN according to RFC 2595 Section 6.
SaslMechAnonymous  SASL ANONYMOUS according to draft-ietf-sasl-anon-05.txt/ RFC 2245 Section 6.
SaslMechExternal  SASL EXTERNAL according to RFC 2222 Section 7.4.
SaslMechGssapi  SASL GSSAPI (Win32 only).
SaslMechAll  Includes all supported SASL mechanisms.

Definition at line 625 of file gloox.h.

The possible fields of a XEP-0055 user search.

Enumerator:
SearchFieldFirst  Search in first names.
SearchFieldLast  Search in last names.
SearchFieldNick  Search in nicknames.
SearchFieldEmail  Search in email addresses.

Definition at line 41 of file searchhandler.h.

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 1073 of file gloox.h.

Describes the defined stanza error conditions of RFC 3920. Used by, eg., Stanza::error().

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 834 of file gloox.h.

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 820 of file gloox.h.

Supported Stanza extension types.

Enumerator:
ExtNone  Invalid StanzaExtension.
ExtVCardUpdate  Extension in the vcard-temp:x:update namspace, advertising a user avatar's SHA1 hash (XEP-0153).
ExtOOB  An extension in the jabber:iq:oob or jabber:x:oob namespaces (XEP-0066).
ExtGPGSigned  An extension containing a GPG/PGP signature (XEP-0027).
ExtGPGEncrypted  An extension containing a GPG/PGP encrypted message (XEP-0027).
ExtXDelay  An extension containing notice of delayed delivery (XEP-0091).
ExtDelay  An extension containing notice of delayed delivery (XEP-0203).

Definition at line 27 of file stanzaextension.h.

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.
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 734 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 722 of file gloox.h.

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 640 of file gloox.h.

Describes stream events that get emitted by means of ConnectionListener::onStreamEvent().

Since:
0.9
Enumerator:
StreamEventConnecting  The Client is about to initaite the connection.
StreamEventEncryption  The Client is about to negotiate encryption.
StreamEventCompression  The Client is about to negotiate compression.
StreamEventAuthentication  The Client is about to authenticate.
StreamEventSessionInit  The Client is about to create a session.
StreamEventResourceBinding  The Client is about to bind a resource to the stream.
StreamEventSessionCreation  The Client is about to create a session.
Since:
0.9.1
StreamEventRoster  The Client is about to request the roster.
StreamEventFinished  The log-in phase is completed.

Definition at line 538 of file gloox.h.

Supported Stream Features.

Enumerator:
StreamFeatureBind  The server supports resource binding.
StreamFeatureSession  The server supports sessions.
StreamFeatureStartTls  The server supports <starttls>.
StreamFeatureIqRegister  The server supports XEP-0077 (In-Band Registration).
StreamFeatureIqAuth  The server supports XEP-0078 (Non-SASL Authentication).
StreamFeatureCompressZlib  The server supports XEP-0138 (Stream Compression) (Zlib).
StreamFeatureCompressDclz  The server supports XEP-0138 (Stream Compression) (LZW/DCLZ).

Definition at line 605 of file gloox.h.

enum TLSPolicy

ClientBase's policy regarding TLS usage. Use with ClientBase::setTls().

Enumerator:
TLSDisabled  Don't use TLS.
TLSOptional  Use TLS if compiled in and offered by the server.
TLSRequired  Don't attempt to log in if the server didn't offer TLS or if TLS was not compiled in. Disconnect error will be ConnTlsNotAvailable.

Definition at line 593 of file gloox.h.


Variable Documentation

GLOOX_API const std::string GLOOX_VERSION = "0.9.9.5"

gloox version

Definition at line 89 of file gloox.cpp.

GLOOX_API const std::string XMLNS_ADHOC_COMMANDS = "http://jabber.org/protocol/commands"

Adhoc Commands namespace (XEP-0050)

Definition at line 25 of file gloox.cpp.

GLOOX_API const std::string XMLNS_AMP = "http://jabber.org/protocol/amp"

Advanced Message Processing (XEP-0079)

Definition at line 30 of file gloox.cpp.

GLOOX_API const std::string XMLNS_ANNOTATIONS = "storage:rosternotes"

Annotations namespace (XEP-0145)

Definition at line 59 of file gloox.cpp.

GLOOX_API const std::string XMLNS_AUTH = "jabber:iq:auth"

Non-SASL Authentication namespace (XEP-0078)

Definition at line 42 of file gloox.cpp.

GLOOX_API const std::string XMLNS_BOOKMARKS = "storage:bookmarks"

Bookmark Storage namespace (XEP-0048)

Definition at line 57 of file gloox.cpp.

GLOOX_API const std::string XMLNS_BYTESTREAMS = "http://jabber.org/protocol/bytestreams"

SOCKS5 Bytestreams namespace (XEP-0065)

Definition at line 65 of file gloox.cpp.

GLOOX_API const std::string XMLNS_CHAT_STATES = "http://jabber.org/protocol/chatstates"

Chat State Notifications namespace (XEP-0085)

Definition at line 29 of file gloox.cpp.

GLOOX_API const std::string XMLNS_CHATNEG = "http://jabber.org/protocol/chatneg"

Chat Session Negotiation namespace (XEP-0155)

Definition at line 33 of file gloox.cpp.

GLOOX_API const std::string XMLNS_CLIENT = "jabber:client"

Client namespace (RFC 3920)

Definition at line 19 of file gloox.cpp.

GLOOX_API const std::string XMLNS_COMPONENT_ACCEPT = "jabber:component:accept"

Component Accept namespace (XEP-0114)

Definition at line 20 of file gloox.cpp.

GLOOX_API const std::string XMLNS_COMPONENT_CONNECT = "jabber:component:connect"

Component Connect namespace (XEP-0114)

Definition at line 21 of file gloox.cpp.

GLOOX_API const std::string XMLNS_COMPRESSION = "http://jabber.org/protocol/compress"

Stream Compression namespace (XEP-0138)

Definition at line 26 of file gloox.cpp.

GLOOX_API const std::string XMLNS_DELAY = "urn:xmpp:delay"

Delayed Delivery namespace (XEP-0203)

Definition at line 36 of file gloox.cpp.

GLOOX_API const std::string XMLNS_DISCO_INFO = "http://jabber.org/protocol/disco#info"

Service Discovery Info namespace (XEP-0030)

Definition at line 23 of file gloox.cpp.

GLOOX_API const std::string XMLNS_DISCO_ITEMS = "http://jabber.org/protocol/disco#items"

Service Discovery Items namespace (XEP-0030)

Definition at line 24 of file gloox.cpp.

GLOOX_API const std::string XMLNS_FEATURE_NEG = "http://jabber.org/protocol/feature-neg"

Feature Negotiation namespace (XEP-0020)

Definition at line 32 of file gloox.cpp.

GLOOX_API const std::string XMLNS_IBB = "http://jabber.org/protocol/ibb"

In-Band Bytestreams namespace (XEP-0047)

Definition at line 31 of file gloox.cpp.

GLOOX_API const std::string XMLNS_IQ_OOB = "jabber:iq:oob"

Out of Band Data (IQ) namespace (XEP-0066)

Definition at line 47 of file gloox.cpp.

GLOOX_API const std::string XMLNS_LAST = "jabber:iq:last"

Last Activity namespace (XEP-0012)

Definition at line 44 of file gloox.cpp.

GLOOX_API const std::string XMLNS_MUC = "http://jabber.org/protocol/muc"

Multi-User Chat namespace (XEP-0045)

Definition at line 66 of file gloox.cpp.

GLOOX_API const std::string XMLNS_MUC_ADMIN = "http://jabber.org/protocol/muc#admin"

Multi-User Chat namespace (admin) (XEP-0045)

Definition at line 68 of file gloox.cpp.

GLOOX_API const std::string XMLNS_MUC_OWNER = "http://jabber.org/protocol/muc#owner"

Multi-User Chat namespace (owner) (XEP-0045)

Definition at line 71 of file gloox.cpp.

GLOOX_API const std::string XMLNS_MUC_REQUEST = "http://jabber.org/protocol/muc#request"

Multi-User Chat namespace (request) (XEP-0045)

Definition at line 74 of file gloox.cpp.

GLOOX_API const std::string XMLNS_MUC_ROOMINFO = "http://jabber.org/protocol/muc#roominfo"

Multi-User Chat namespace (roominfo) (XEP-0045)

Definition at line 72 of file gloox.cpp.

GLOOX_API const std::string XMLNS_MUC_ROOMS = "http://jabber.org/protocol/muc#rooms"

Multi-User Chat namespace (rooms) (XEP-0045)

Definition at line 73 of file gloox.cpp.

GLOOX_API const std::string XMLNS_MUC_UNIQUE = "http://jabber.org/protocol/muc#unique"

Multi-User Chat namespace (unique) (XEP-0045)

Definition at line 69 of file gloox.cpp.

GLOOX_API const std::string XMLNS_MUC_USER = "http://jabber.org/protocol/muc#user"

Multi-User Chat namespace (user) (XEP-0045)

Definition at line 67 of file gloox.cpp.

GLOOX_API const std::string XMLNS_OFFLINE = "http://jabber.org/protocol/offline"

Flexible Offline Message Retrieval (XEP-0013)

Definition at line 27 of file gloox.cpp.

GLOOX_API const std::string XMLNS_PRIVACY = "jabber:iq:privacy"

Privacy lists namespace (RFC 3921)

Definition at line 41 of file gloox.cpp.

GLOOX_API const std::string XMLNS_PRIVATE_XML = "jabber:iq:private"

Private XML Storage namespace (XEP-0049)

Definition at line 43 of file gloox.cpp.

GLOOX_API const std::string XMLNS_REGISTER = "jabber:iq:register"

In-Band Registration namespace (XEP-0077)

Definition at line 39 of file gloox.cpp.

GLOOX_API const std::string XMLNS_ROSTER = "jabber:iq:roster"

Roster namespace (RFC 3921)

Definition at line 37 of file gloox.cpp.

GLOOX_API const std::string XMLNS_ROSTER_DELIMITER = "roster:delimiter"

Nested Roster Groups namespace (XEP-0083)

Definition at line 60 of file gloox.cpp.

GLOOX_API const std::string XMLNS_SEARCH = "jabber:iq:search"

Jabber Search namespace (XEP-0055)

Definition at line 45 of file gloox.cpp.

GLOOX_API const std::string XMLNS_SI = "http://jabber.org/protocol/si"

Stream Initiation namespace (XEP-0095)

Definition at line 62 of file gloox.cpp.

GLOOX_API const std::string XMLNS_SI_FT = "http://jabber.org/protocol/si/profile/file-transfer"

File transfer profile of Stream Initiation (XEP-0096)

Definition at line 63 of file gloox.cpp.

GLOOX_API const std::string XMLNS_STREAM_BIND = "urn:ietf:params:xml:ns:xmpp-bind"

Resource Bind Stream Feature (RFC 3921)

Definition at line 80 of file gloox.cpp.

GLOOX_API const std::string XMLNS_STREAM_COMPRESS = "http://jabber.org/features/compress"

Stream Compression Feature namespace (XEP-0138)

Definition at line 85 of file gloox.cpp.

GLOOX_API const std::string XMLNS_STREAM_IQAUTH = "http://jabber.org/features/iq-auth"

Non-SASL Auth. Stream Feature (XEP-0078)

Definition at line 83 of file gloox.cpp.

GLOOX_API const std::string XMLNS_STREAM_IQREGISTER = "http://jabber.org/features/iq-register"

In-Band Registration namespace (XEP-0077)

Definition at line 84 of file gloox.cpp.

GLOOX_API const std::string XMLNS_STREAM_SASL = "urn:ietf:params:xml:ns:xmpp-sasl"

SASL Stream Feature namespace (RFC 3920)

Definition at line 79 of file gloox.cpp.

GLOOX_API const std::string XMLNS_STREAM_SESSION = "urn:ietf:params:xml:ns:xmpp-session"

Session Create Stream Feature (RFC 3921)

Definition at line 81 of file gloox.cpp.

GLOOX_API const std::string XMLNS_STREAM_TLS = "urn:ietf:params:xml:ns:xmpp-tls"

TLS Stream Feature namespace (RFC 3920)

Definition at line 78 of file gloox.cpp.

GLOOX_API const std::string XMLNS_VCARD_TEMP = "vcard-temp"

vcard-temp namespace (XEP-0054)

Definition at line 55 of file gloox.cpp.

GLOOX_API const std::string XMLNS_VERSION = "jabber:iq:version"

Software Version namespace (XEP-0092)

Definition at line 38 of file gloox.cpp.

GLOOX_API const std::string XMLNS_X_DATA = "jabber:x:data"

Data Forms namespace (XEP-0004)

Definition at line 48 of file gloox.cpp.

GLOOX_API const std::string XMLNS_X_DELAY = "jabber:x:delay"

Delayed Delivery namespace (XEP-0091)

Definition at line 51 of file gloox.cpp.

GLOOX_API const std::string XMLNS_X_EVENT = "jabber:x:event"

Message Events (XEP-0022)

Definition at line 49 of file gloox.cpp.

GLOOX_API const std::string XMLNS_X_GPGENCRYPTED = "jabber:x:encrypted"

Current Jabber OpenPGP Usage (Enc.) (XEP-0027)

Definition at line 54 of file gloox.cpp.

GLOOX_API const std::string XMLNS_X_GPGSIGNED = "jabber:x:signed"

Current Jabber OpenPGP Usage (Sign.) (XEP-0027)

Definition at line 53 of file gloox.cpp.

GLOOX_API const std::string XMLNS_X_OOB = "jabber:x:oob"

Out of Band Data (X) namespace (XEP-0066)

Definition at line 50 of file gloox.cpp.

GLOOX_API const std::string XMLNS_X_VCARD_UPDATE = "vcard-temp:x:update"

vCard-Based Avatars namespace (XEP-0153)

Definition at line 56 of file gloox.cpp.

GLOOX_API const std::string XMLNS_XHTML_IM = "http://jabber.org/protocol/xhtml-im"

XHTML-IM namespace (XEP-0071)

Definition at line 35 of file gloox.cpp.

GLOOX_API const std::string XMLNS_XMPP_PING = "urn:xmpp:ping"

XMPP Ping namespace (XEP-0199)

Definition at line 61 of file gloox.cpp.

GLOOX_API const std::string XMLNS_XMPP_STANZAS = "urn:ietf:params:xml:ns:xmpp-stanzas"

XMPP stanzas namespace (RFC 3920)

Definition at line 77 of file gloox.cpp.

GLOOX_API const std::string XMLNS_XMPP_STREAM = "urn:ietf:params:xml:ns:xmpp-streams"

XMPP stream namespace (RFC 3920)

Definition at line 75 of file gloox.cpp.

GLOOX_API const std::string XMPP_STREAM_VERSION_MAJOR = "1"

Supported stream version (major).

Definition at line 87 of file gloox.cpp.

GLOOX_API const std::string XMPP_STREAM_VERSION_MINOR = "0"

Supported stream version (minor).

Definition at line 88 of file gloox.cpp.


Generated on Sun Apr 27 11:08:14 2008 for gloox by  doxygen 1.5.5