Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | Related Pages
gloox::ClientBase

ClientBase Class Reference

This is the common base class for a Jabber/XMPP Client and a jabber Component. More...

#include <clientbase.h>

Inherits TagHandler, ConnectionDataHandler, CompressionDataHandler, and TLSHandler.

Inherited by Client, and Component.

Inheritance diagram for ClientBase:

Inheritance graph
[legend]
Collaboration diagram for ClientBase:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ClientBase (const std::string &ns, const std::string &server, int port=-1)
 ClientBase (const std::string &ns, const std::string &password, const std::string &server, int port=-1)
virtual ~ClientBase ()
bool connect (bool block=true)
ConnectionError recv (int timeout=-1)
virtual const std::string & username () const
const JID & jid ()
void setSasl (bool sasl)
GLOOX_DEPRECATED void setTls (bool tls)
void setTls (TLSPolicy tls)
void setCompression (bool compression)
void setPort (int port)
void setServer (const std::string &server)
void setPassword (const std::string &password)
const std::string & server () const
bool sasl () const
bool tls () const
bool compression () const
int port () const
virtual const std::string & password () const
virtual Disco * disco () const
const std::string getID ()
virtual void send (Tag *tag)
bool authed () const
ConnectionState state () const
const std::string & xmlLang () const
void setXmlLang (const std::string &xmllang)
ConnectionBase * connectionImpl () const
void setConnectionImpl (ConnectionBase *cb)
TLSBase * encryptionImpl () const
void setEncryptionImpl (TLSBase *tb)
CompressionBase * compressionImpl () const
void setCompressionImpl (CompressionBase *cb)
void whitespacePing ()
void xmppPing (const JID &to)
void setAuthzid (const JID &authzid)
void setSASLMechanisms (int mechanisms)
void registerConnectionListener (ConnectionListener *cl)
void registerIqHandler (IqHandler *ih, const std::string &xmlns)
void trackID (IqHandler *ih, const std::string &id, int context)
void removeIDHandler (IqHandler *ih)
void registerMessageHandler (MessageHandler *mh)
void removeMessageHandler (MessageHandler *mh)
void registerMessageSession (MessageSession *session)
void disposeMessageSession (MessageSession *session)
void registerPresenceHandler (PresenceHandler *ph)
void registerPresenceHandler (const JID &jid, PresenceHandler *ph)
void registerSubscriptionHandler (SubscriptionHandler *sh)
void registerTagHandler (TagHandler *th, const std::string &tag, const std::string &xmlns)
void registerStatisticsHandler (StatisticsHandler *sh)
void removeConnectionListener (ConnectionListener *cl)
void removeIqHandler (const std::string &xmlns)
void removePresenceHandler (PresenceHandler *ph)
void removePresenceHandler (const JID &jid, PresenceHandler *ph)
void removeSubscriptionHandler (SubscriptionHandler *sh)
void removeTagHandler (TagHandler *th, const std::string &tag, const std::string &xmlns)
void removeStatisticsHandler ()
void setCACerts (const StringList &cacerts)
void setClientCert (const std::string &clientKey, const std::string &clientCerts)
void registerMessageSessionHandler (MessageSessionHandler *msh, int types=0)
LogSink & logInstance ()
StreamError streamError () const
const std::string streamErrorText (const std::string &lang="default") const
const std::string & streamErrorCData () const
const Tag * streamErrorAppCondition () const
AuthenticationError authError () const
StatisticsStruct getStatistics ()
void registerMUCInvitationHandler (MUCInvitationHandler *mih)
void removeMUCInvitationHandler ()
virtual void handleTag (Tag *tag)
virtual void handleCompressedData (const std::string &data)
virtual void handleDecompressedData (const std::string &data)
virtual void handleReceivedData (const ConnectionBase *connection, const std::string &data)
virtual void handleConnect (const ConnectionBase *connection)
virtual void handleDisconnect (const ConnectionBase *connection, ConnectionError reason)
virtual void handleEncryptedData (const TLSBase *base, const std::string &data)
virtual void handleDecryptedData (const TLSBase *base, const std::string &data)
virtual void handleHandshakeResult (const TLSBase *base, bool success, CertInfo &certinfo)

Detailed Description

This is the common base class for a Jabber/XMPP Client and a jabber Component.

It manages connection establishing, authentication, filter registration and invocation.

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

Definition at line 60 of file clientbase.h.

Constructor & Destructor Documentation

ClientBase (  const std::string &  ns,
const std::string &  server,
int  port = -1
) 
 

Constructs a new ClientBase. You should not need to use this class directly. Use Client or Component instead.

Parameters:
ns The namespace which qualifies the stream. Either jabber:client or jabber:component:*
server The server to connect to.
port The port to connect to. The default of -1 means to look up the port via DNS SRV or to use a default port of 5222 as defined in XMPP Core.

Definition at line 62 of file clientbase.cpp.

ClientBase (  const std::string &  ns,
const std::string &  password,
const std::string &  server,
int  port = -1
) 
 

Constructs a new ClientBase. You should not need to use this class directly. Use Client or Component instead.

Parameters:
ns The namespace which qualifies the stream. Either jabber:client or jabber:component:*
password The password to use for further authentication.
server The server to connect to.
port The port to connect to. The default of -1 means to look up the port via DNS SRV or to use a default port of 5222 as defined in XMPP: Core.

Definition at line 77 of file clientbase.cpp.

~ClientBase (   )  [virtual]
 

Virtual destrcuctor.

Definition at line 128 of file clientbase.cpp.

Member Function Documentation

bool authed (   )  const [inline]
 

Returns whether authentication has taken place and was successful.

Returns:
True if authentication has been carried out and was successful, false otherwise.

Definition at line 245 of file clientbase.h.

AuthenticationError authError (   )  const [inline]
 

Use this function to retrieve the type of the authentication error after it occurs and you received a ConnectionError of type ConnAuthenticationFailed from the ConnectionListener.

Returns:
The type of the authentication, if any, AuthErrorUndefined otherwise.

Definition at line 576 of file clientbase.h.

bool compression (   )  const [inline]
 

Returns whether Stream Compression is currently enabled (not necessarily used).

Returns:
The current Stream Compression status.

Definition at line 204 of file clientbase.h.

CompressionBase* compressionImpl (   )  const [inline]
 

This function returns the concrete compression implementation currently in use.

Returns:
The concrete compression implementation.
Since:
0.9

Definition at line 304 of file clientbase.h.

bool connect (  bool  block = true  ) 
 

Initiates the connection to a server. This function blocks as long as a connection is established. You can have the connection block 'til the end of the connection, or you can have it return immediately. If you choose the latter, its your responsibility to call recv() every now and then to actually receive data from the socket and to feed the parser.

Parameters:
block True for blocking, false for non-blocking connect. Defaults to true.
Returns:
False if prerequisits are not met (server not set) or if the connection was refused, true otherwise.
Note:
Since 0.9 onDisconnect() is called in addition to a return value of false.

Definition at line 153 of file clientbase.cpp.

ConnectionBase* connectionImpl (   )  const [inline]
 

This function returns the concrete connection implementation currently in use.

Returns:
The concrete connection implementation.
Since:
0.9

Definition at line 272 of file clientbase.h.

virtual Disco* disco (   )  const [inline, virtual]
 

This function gives access to the Disco object.

Returns:
A pointer to the Disco object.

Definition at line 223 of file clientbase.h.

void disposeMessageSession (  MessageSession *  session  ) 
 

Removes the given MessageSession from the list of MessageSessions and deletes it.

Parameters:
session The MessageSession to be deleted.

Definition at line 927 of file clientbase.cpp.

TLSBase* encryptionImpl (   )  const [inline]
 

This function returns the concrete encryption implementation currently in use.

Returns:
The concrete encryption implementation.
Since:
0.9

Definition at line 288 of file clientbase.h.

const std::string getID (   ) 
 

Creates a string which is unique in the current instance and can be used as an ID for queries.

Returns:
A unique string suitable for query IDs.

Definition at line 686 of file clientbase.cpp.

StatisticsStruct getStatistics (   ) 
 

Returns a StatisticsStruct containing byte and stanza counts for the current active connection.

Returns:
A struct containing the current connection's statistics.

Definition at line 652 of file clientbase.cpp.

void handleCompressedData (  const std::string &  data  )  [virtual]
 

This function is called when compression is finished.

Parameters:
data The compressed data.

Implements CompressionDataHandler.

Definition at line 254 of file clientbase.cpp.

void handleConnect (  const ConnectionBase *  connection  )  [virtual]
 

This function is called when e.g. the raw TCP connection was established.

Parameters:
connection The connection.

Implements ConnectionDataHandler.

Definition at line 324 of file clientbase.cpp.

void handleDecompressedData (  const std::string &  data  )  [virtual]
 

This function is called when decompression is finished.

Parameters:
data The decompressed data.

Implements CompressionDataHandler.

Definition at line 264 of file clientbase.cpp.

void handleDecryptedData (  const TLSBase *  base,
const std::string &  data
)  [virtual]
 

Reimplement this function to receive decrypted data from a TLSBase implementation.

Parameters:
base The encryption implementation which called this function.
data The decrypted data (e.g. to parse).

Implements TLSHandler.

Definition at line 280 of file clientbase.cpp.

void handleDisconnect (  const ConnectionBase *  connection,
ConnectionError  reason
)  [virtual]
 

This connection is called when e.g. the raw TCP connection was closed.

Parameters:
connection The connection.
reason The reason for the disconnect.

Implements ConnectionDataHandler.

Definition at line 333 of file clientbase.cpp.

void handleEncryptedData (  const TLSBase *  base,
const std::string &  data
)  [virtual]
 

Reimplement this function to receive encrypted data from a TLSBase implementation.

Parameters:
base The encryption implementation which called this function.
data The encrypted data (e.g. to send over the wire).

Implements TLSHandler.

Definition at line 272 of file clientbase.cpp.

void handleHandshakeResult (  const TLSBase *  base,
bool  success,
CertInfo &  certinfo
)  [virtual]
 

Reimplement this function to receive the result of a TLS handshake.

Parameters:
base The encryption implementation which called this function.
success Whether or not the handshake was successful.
certinfo Information about the server's certificate.

Implements TLSHandler.

Definition at line 290 of file clientbase.cpp.

void handleReceivedData (  const ConnectionBase *  connection,
const std::string &  data
)  [virtual]
 

This function is called for received from the underlying transport.

Parameters:
connection The connection that received the data.
data The data received.

Implements ConnectionDataHandler.

Definition at line 312 of file clientbase.cpp.

void handleTag (  Tag *  tag  )  [virtual]
 

This function is called when a registered XML element arrives. As with every handler in gloox, the Tag is going to be deleted after this function returned. If you need a copy afterwards, create it using Tag::clone().

Parameters:
tag The complete Tag.

Implements TagHandler.

Definition at line 186 of file clientbase.cpp.

const JID& jid (   )  [inline]
 

Returns the current Jabber ID. If an authentication ID has been set (using setAuthzid()) this authzid is returned.

Returns:
A reference to the Jabber ID.
Note:
If you change the server part of the JID, the server of the connection is not synced. You have to do that manually using setServer().

Definition at line 130 of file clientbase.h.

LogSink & logInstance (   ) 
 

Returns the LogSink instance for this ClientBase and all related objects.

Returns:
The LogSink instance used in the current ClientBase.

Definition at line 719 of file clientbase.cpp.

virtual const std::string& password (   )  const [inline, virtual]
 

Returns the current password.

Returns:
The password used to connect.

Definition at line 217 of file clientbase.h.

int port (   )  const [inline]
 

Returns the port. The default of -1 means that the actual port will be looked up using SRV records, or the XMPP default port of 5222 will be used.

Returns:
The port used to connect.

Definition at line 211 of file clientbase.h.

ConnectionError recv (  int  timeout = -1  ) 
 

Use this periodically to receive data from the socket and to feed the parser. You need to use this only if you chose to connect in non-blocking mode.

Parameters:
timeout The timeout in microseconds to use for select. Default of -1 means blocking until data was available.
Returns:
The state of the connection.

Definition at line 145 of file clientbase.cpp.

void registerConnectionListener (  ConnectionListener *  cl  ) 
 

Registers cl as object that receives connection notifications.

Parameters:
cl The object to receive connection notifications.

Definition at line 1016 of file clientbase.cpp.

void registerIqHandler (  IqHandler *  ih,
const std::string &  xmlns
) 
 

Registers ih as object that receives Iq stanza notifications for namespace xmlns. Only one handler per namespace is possible.

Parameters:
ih The object to receive Iq stanza notifications.
xmlns The namespace the object handles.

Definition at line 909 of file clientbase.cpp.

void registerMessageHandler (  MessageHandler *  mh  ) 
 

Registers mh as object that receives Message stanza notifications.

Parameters:
mh The object to receive Message stanza notifications.

Definition at line 941 of file clientbase.cpp.

void registerMessageSession (  MessageSession *  session  ) 
 

Registers the given MessageSession to receive Messages incoming from the session's target JID.

Note:
The ClientBase instance becomes the owner of the MessageSession, it will be deleted in ClientBase's destructor. To get rid of the session before that, use disposeMessageSession().
Parameters:
session The MessageSession to register.
Note:
Since a MessageSession automatically registers itself with the ClientBase, there is no need to call this function directly.

Definition at line 921 of file clientbase.cpp.

void registerMessageSessionHandler (  MessageSessionHandler *  msh,
int  types = 0
) 
 

Use this function to register a MessageSessionHandler with the Client. Optionally the MessageSessionHandler can receive only MessageSessions with a given message type. There can be only one handler per message type.
A MessageSession will be created for every incoming message stanza if there is no MessageHandler registered for the originating JID.

Parameters:
msh The MessageSessionHandler that will receive the newly created MessageSession.
types ORed StanzaSubType's that describe the desired message types the handler shall receive. Only StanzaMessage* types are valid. A value of 0 means any type (default).

Definition at line 831 of file clientbase.cpp.

void registerMUCInvitationHandler (  MUCInvitationHandler *  mih  ) 
 

Registers a MUCInvitationHandler with the ClientBase.

Parameters:
mih The MUCInvitationHandler to register.

Definition at line 1001 of file clientbase.cpp.

void registerPresenceHandler (  const JID &  jid,
PresenceHandler *  ph
) 
 

Registers a new PresenceHandler for the given JID. Presences received for this particular JID will not be forwarded to the generic PresenceHandler (and therefore the Roster). This functionality is primarily intended for the MUC implementation.

Parameters:
jid The JID to 'watch'.
ph The PresenceHandler to inform about presence changes from jid.
Since:
0.9

Definition at line 858 of file clientbase.cpp.

void registerPresenceHandler (  PresenceHandler *  ph  ) 
 

Registers ph as object that receives Presence stanza notifications.

Parameters:
ph The object to receive Presence stanza notifications.

Definition at line 846 of file clientbase.cpp.

void registerStatisticsHandler (  StatisticsHandler *  sh  ) 
 

Registers sh as object that receives up-to-date connection statistics each time a Stanza is received or sent. Alternatively, you can use getStatistics() manually. Only one StatisticsHandler per ClientBase at a time is possible.

Parameters:
sh The StatisticsHandler to register.

Definition at line 990 of file clientbase.cpp.

void registerSubscriptionHandler (  SubscriptionHandler *  sh  ) 
 

Registers sh as object that receives Subscription stanza notifications.

Parameters:
sh The object to receive Subscription stanza notifications.

Definition at line 953 of file clientbase.cpp.

void registerTagHandler (  TagHandler *  th,
const std::string &  tag,
const std::string &  xmlns
) 
 

Registers th as object that receives incoming packts with a given root tag qualified by the given namespace.

Parameters:
th The object to receive Subscription packet notifications.
tag The element's name.
xmlns The element's namespace.

Definition at line 965 of file clientbase.cpp.

void removeConnectionListener (  ConnectionListener *  cl  ) 
 

Removes the given object from the list of connection listeners.

Parameters:
cl The object to remove from the list.

Definition at line 1022 of file clientbase.cpp.

void removeIDHandler (  IqHandler *  ih  ) 
 

Removes the given IqHandler from the list of handlers of pending operations, added using trackID(). Necessary, for example, when closing a GUI element that has an operation pending.

Parameters:
ih The IqHandler to remove.
Since:
0.8.7

Definition at line 896 of file clientbase.cpp.

void removeIqHandler (  const std::string &  xmlns  ) 
 

Removes the handler for the given namespace from the list of Iq handlers.

Parameters:
xmlns The namespace to remove from the list.

Definition at line 915 of file clientbase.cpp.

void removeMessageHandler (  MessageHandler *  mh  ) 
 

Removes the given object from the list of message handlers.

Parameters:
mh The object to remove from the list.

Definition at line 947 of file clientbase.cpp.

void removeMUCInvitationHandler (   ) 
 

Removes the currently registered MUCInvitationHandler.

Definition at line 1010 of file clientbase.cpp.

void removePresenceHandler (  const JID &  jid,
PresenceHandler *  ph
) 
 

Removes the given object from the list of presence handlers for the given JID.

Parameters:
jid The JID to remove the PresenceHandler(s) for.
ph The PresenceHandler to remove from the list. If ph is 0, all handlers for the given JID will be removed.

Definition at line 869 of file clientbase.cpp.

void removePresenceHandler (  PresenceHandler *  ph  ) 
 

Removes the given object from the list of presence handlers.

Parameters:
ph The object to remove from the list.

Definition at line 852 of file clientbase.cpp.

void removeStatisticsHandler (   ) 
 

Removes the current StatisticsHandler.

Definition at line 996 of file clientbase.cpp.

void removeSubscriptionHandler (  SubscriptionHandler *  sh  ) 
 

Removes the given object from the list of subscription handlers.

Parameters:
sh The object to remove from the list.

Definition at line 959 of file clientbase.cpp.

void removeTagHandler (  TagHandler *  th,
const std::string &  tag,
const std::string &  xmlns
) 
 

Removes the given object from the list of tag handlers for the given element and namespace.

Parameters:
th The object to remove from the list.
tag The element to remove the handler for.
xmlns The namespace qualifying the element.

Definition at line 977 of file clientbase.cpp.

bool sasl (   )  const [inline]
 

Returns whether SASL is currently enabled (not necessarily used).

Returns:
The current SASL status.

Definition at line 192 of file clientbase.h.

void send (  Tag *  tag  )  [virtual]
 

Sends a given Tag over an established connection. The ClientBase object becomes the owner of this Tag and will delete it after sending it. You should not rely on the existance of the Tag after it's been sent. If you still need it after sending it, use Tag::clone() to create a deep copy.

Parameters:
tag The Tag to send.

Definition at line 605 of file clientbase.cpp.

const std::string& server (   )  const [inline]
 

Returns the current prepped server.

Returns:
The server used to connect.

Definition at line 186 of file clientbase.h.

void setAuthzid (  const JID &  authzid  )  [inline]
 

Use this function to set an authorization ID (authzid). Provided the server supports it and the user has sufficient rights, they could then authenticate as bob@example.net but act as alice@example.net.

Parameters:
authzid The JID to authorize as. Only the bare JID is used.
Since:
0.9

Definition at line 336 of file clientbase.h.

void setCACerts (  const StringList &  cacerts  )  [inline]
 

Use this function to set a number of trusted root CA certificates which shall be used to verify a servers certificate.

Parameters:
cacerts A list of absolute paths to CA root certificate files in PEM format.

Definition at line 504 of file clientbase.h.

void setClientCert (  const std::string &  clientKey,
const std::string &  clientCerts
) 
 

Use this function to set the user's certificate and private key. The certificate will be presented to the server upon request and can be used for SASL EXTERNAL authentication. The user's certificate file should be a bundle of more than one certificate in PEM format. The first one in the file should be the user's certificate, each cert following that one should have signed the previous one.

Note:
These certificates are not necessarily the same as those used to verify the server's certificate.
Parameters:
clientKey The absolute path to the user's private key in PEM format.
clientCerts A path to a certificate bundle in PEM format.

Definition at line 405 of file clientbase.cpp.

void setCompression (  bool  compression  )  [inline]
 

Switches usage of Stream Compression on/off (if available). Default: on if available. Stream Compression should only be disabled if there are problems with using it.

Parameters:
compression Whether to switch Stream Compression usage on or off.

Definition at line 158 of file clientbase.h.

void setCompressionImpl (  CompressionBase *  cb  ) 
 

Use this function if you have a class supporting some fancy compression algorithm. This should be called before calling connect(). If there already is a compression implementation set (either manually or automatically), it gets deleted.

Parameters:
cb The compression implementation to use.
Since:
0.9

Definition at line 742 of file clientbase.cpp.

void setConnectionImpl (  ConnectionBase *  cb  ) 
 

Use this function if you have a class implementing a UDP, SCTP (or whatever) connection. This should be called before calling connect(). If there already is a connection implementation set (either manually or automatically), it gets deleted.

Parameters:
cb The connection to use.
Since:
0.9

Definition at line 724 of file clientbase.cpp.

void setEncryptionImpl (  TLSBase *  tb  ) 
 

Use this function if you have a class supporting hardware encryption (or whatever). This should be called before calling connect(). If there already is a encryption implementation set (either manually or automatically), it gets deleted.

Parameters:
tb The encryption implementation to use.
Since:
0.9

Definition at line 733 of file clientbase.cpp.

void setPassword (  const std::string &  password  )  [inline]
 

Sets the password to use to connect to the XMPP server.

Parameters:
password The password to use for authentication.

Definition at line 180 of file clientbase.h.

void setPort (  int  port  )  [inline]
 

Sets the port to connect to. This is not necessary if either the default port (5222) is used or SRV records exist which will be resolved.

Parameters:
port The port to connect to.

Definition at line 165 of file clientbase.h.

void setSasl (  bool  sasl  )  [inline]
 

Switches usage of SASL on/off. Default: on. SASL should only be disabled if there are problems with using it.

Parameters:
sasl Whether to switch SASL usage on or off.

Definition at line 137 of file clientbase.h.

void setSASLMechanisms (  int  mechanisms  )  [inline]
 

Use this function to limit SASL mechanisms gloox can use. By default, all supported mechanisms are allowed. To exclude one (or more) mechanisms, remove it from SaslMechAll like so: 

 int mymechs = SaslMechAll ^ SaslMechDigestMd5;
Parameters:
mechanisms Bitwise ORed SaslMechanism.
Since:
0.9

Definition at line 348 of file clientbase.h.

void setServer (  const std::string &  server  ) 
 

Sets the XMPP server to connect to.

Parameters:
server The server to connect to. Either IP or fully qualified domain name.
Note:
If you change the server, the server part of the JID is not synced. You have to do that manually using jid() and JID::setServer().

This function also sets the server of the Connection(Base) in use.

Definition at line 398 of file clientbase.cpp.

void setTls (  TLSPolicy  tls  )  [inline]
 

Sets the TLS policy. Default: TLS will be used if available. TLS should only be disabled if there are problems with using it.

Parameters:
tls The TLS policy.

Definition at line 151 of file clientbase.h.

GLOOX_DEPRECATED void setTls (  bool  tls  )  [inline]
 

Switches usage of TLS on/off (if available). Default: on if available. TLS should only be disabled if there are problems with using it.

Parameters:
tls Whether to switch TLS usage on or off.

Definition at line 144 of file clientbase.h.

void setXmlLang (  const std::string &  xmllang  )  [inline]
 

Sets the value for the xml:lang attribute of the initial stream.

Parameters:
xmllang The language identifier for the stream. It must conform to section 2.12 of the XML specification and RFC 3066. Default is 'en'.

Definition at line 265 of file clientbase.h.

ConnectionState state (   )  const
 

Returns the current connection status.

Returns:
The status of the connection.

Definition at line 662 of file clientbase.cpp.

StreamError streamError (   )  const [inline]
 

Use this function to retrieve the type of the stream error after it occurs and you received a ConnectionError of type ConnStreamError from the ConnectionListener.

Returns:
The StreamError.
Note:
The return value is only meaningful when called from ConnectionListener::onDisconnect().

Definition at line 543 of file clientbase.h.

const Tag* streamErrorAppCondition (   )  const [inline]
 

This function can be used to retrieve the application-specific error condition of a stream error.

Returns:
The application-specific error element of a stream error. 0 if no respective element was found or no error occured.

Definition at line 569 of file clientbase.h.

const std::string& streamErrorCData (   )  const [inline]
 

In case the defined-condition element of an stream error contains XML character data you can use this function to retrieve it. RFC 3920 only defines one condition (see-other-host)where this is possible.

Returns:
The cdata of the stream error's text element (only for see-other-host).

Definition at line 562 of file clientbase.h.

const std::string streamErrorText (  const std::string &  lang = "default"  )  const
 

Returns the text of a stream error for the given language if available. If the requested language is not available, the default text (without a xml:lang attribute) will be returned.

Parameters:
lang The language identifier for the desired language. It must conform to section 2.12 of the XML specification and RFC 3066. If empty, the default body will be returned, if any.
Returns:
The describing text of a stream error. Empty if no stream error occured.

Definition at line 825 of file clientbase.cpp.

bool tls (   )  const [inline]
 

Returns whether TLS is currently enabled (not necessarily used).

Returns:
The current TLS status.

Definition at line 198 of file clientbase.h.

void trackID (  IqHandler *  ih,
const std::string &  id,
int  context
) 
 

Use this function to be notified of incoming IQ stanzas with the given value of the id attribute. Since IDs are supposed to be unique, this notification works only once.

Parameters:
ih The IqHandler to receive notifications.
id The id to track.
context A value that allows for restoring context.

Definition at line 885 of file clientbase.cpp.

virtual const std::string& username (   )  const [inline, virtual]
 

Reimplement this function to provide a username for connection purposes.

Returns:
The username.

Definition at line 121 of file clientbase.h.

void whitespacePing (   ) 
 

Sends a whitespace ping to the server.

Since:
0.9

Definition at line 667 of file clientbase.cpp.

const std::string& xmlLang (   )  const [inline]
 

Retrieves the value of the xml:lang attribute of the initial stream. Default is 'en', i.e. if not changed by a call to setXmlLang().

Definition at line 257 of file clientbase.h.

void xmppPing (  const JID &  to  ) 
 

Sends a XMPP Ping (XEP-0199) to the given JID. There is currently no way to know whether the remote entity answered (other than registering an IQ handler for the urn:xmpp:ping namespace).

Since:
0.9

Definition at line 672 of file clientbase.cpp.

The documentation for this class was generated from the following files:
Generated on Sat Oct 31 19:56:21 2009 for gloox by  doxygen 1.4.1