-

QXmppConfiguration Class Reference

-

The QXmppConfiguration class holds configuration options. -More...

- -

#include <QXmppConfiguration.h>

- -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Types
enum	StreamSecurityMode { TLSEnabled = 0, -TLSDisabled, -TLSRequired - }
enum	NonSASLAuthMechanism { NonSASLPlain = 0, -NonSASLDigest - }
enum	SASLAuthMechanism { SASLPlain = 0, -SASLDigestMD5, -SASLAnonymous - }
Public Member Functions
-	QXmppConfiguration ()
	Creates a QXmppConfiguration object.
	~QXmppConfiguration ()
QString	host () const
QString	domain () const
int	port () const
QString	user () const
QString	passwd () const
QString	resource () const
QString	jid () const
QString	jidBare () const
bool	autoAcceptSubscriptions () const
bool	autoReconnectionEnabled () const
bool	useSASLAuthentication () const
bool	ignoreSslErrors () const
QXmppConfiguration::StreamSecurityMode	streamSecurityMode () const
QXmppConfiguration::NonSASLAuthMechanism	nonSASLAuthMechanism () const
QXmppConfiguration::SASLAuthMechanism	sASLAuthMechanism () const
QNetworkProxy	networkProxy () const
int	keepAliveInterval () const
void	setKeepAliveInterval (int secs)
-int	keepAliveTimeout () const
	Returns the keep alive timeout in seconds.
void	setKeepAliveTimeout (int secs)
void	setHost (const QString &)
void	setDomain (const QString &)
void	setPort (int)
void	setUser (const QString &)
void	setPasswd (const QString &)
void	setResource (const QString &)
void	setAutoAcceptSubscriptions (bool)
void	setAutoReconnectionEnabled (bool)
void	setUseSASLAuthentication (bool)
void	setIgnoreSslErrors (bool)
void	setStreamSecurityMode (QXmppConfiguration::StreamSecurityMode mode)
void	setNonSASLAuthMechanism (QXmppConfiguration::NonSASLAuthMechanism)
void	setSASLAuthMechanism (QXmppConfiguration::SASLAuthMechanism)
void	setNetworkProxy (const QNetworkProxy &proxy)

-

Detailed Description

-

The QXmppConfiguration class holds configuration options.

-

It can be passed to QXmppClient to specify the options when connecting to an XMPP server.

-

It is a container of all the settings, configuration required for connecting to an XMPP server. E.g. server name, username, port, type of authentication mechanism, type of security used by stream (encryption), etc..

-

Member Enumeration Documentation

- -

-

- - - - -

enum QXmppConfiguration::NonSASLAuthMechanism

-

An enumeration for various Non-SASL authentication mechanisms available. The server may or may not allow QXmppConfiguration::Plain mechanism. So specifying the mechanism is just a hint to the library.

-

Enumerator:

- - -

NonSASLPlain	- Plain. -
NonSASLDigest	- Digest (default). -

-

- -

-

- -

-

- - - - -

enum QXmppConfiguration::SASLAuthMechanism

-

An enumeration for various SASL authentication mechanisms available. The server may or may not allow any particular mechanism. So depending upon the availability of mechanisms on the server the library will choose a mechanism.

-

Enumerator:

- - - -

SASLPlain	- Plain. -
SASLDigestMD5	- Digest MD5 (default). -
SASLAnonymous	- Anonymous. -

-

- -

-

- -

-

- - - - -

enum QXmppConfiguration::StreamSecurityMode

-

An enumeration for type of the Security Mode that is stream is encrypted or not. The server may or may not have TLS feature. Server may force the encryption. Depending upon all this user can specify following options.

-

Enumerator:

- - - -

TLSEnabled	- Encryption is used if available (default). -
TLSDisabled	- No encryption is server allows. -
TLSRequired	- Encryption is a must otherwise connection would not be established -

-

- -

-

Constructor & Destructor Documentation

- -

-

- - - - - - - - -

QXmppConfiguration::~QXmppConfiguration ( )

-

Destructor, destroys the QXmppConfiguration object.

- -

-

Member Function Documentation

- -

-

- - - - - - - - -

bool QXmppConfiguration::autoAcceptSubscriptions ( ) const

-

Returns the auto-accept-subscriptions-request configuration.

-

Returns:: boolean value true means that auto-accept-subscriptions-request is enabled else disabled for false

- -

-

- -

-

- - - - - - - - -

bool QXmppConfiguration::autoReconnectionEnabled ( ) const

-

Returns the auto-reconnect-on-disconnection-on-error configuration.

-

Returns:: boolean value true means that auto-reconnect is enabled else disabled for false

- -

-

- -

-

- - - - - - - - -

QString QXmppConfiguration::domain ( ) const

-

Returns the domain name.

-

Returns:: domain name

- -

-

- -

-

- - - - - - - - -

QString QXmppConfiguration::host ( ) const

-

Returns the host name.

-

Returns:: host name

- -

-

- -

-

- - - - - - - - -

bool QXmppConfiguration::ignoreSslErrors ( ) const

-

Returns whether SSL errors (such as certificate validation errors) are to be ignored when connecting to the XMPP server.

- -

-

- -

-

- - - - - - - - -

QString QXmppConfiguration::jid ( ) const

-

Returns the jabber id (jid).

-

Returns:: jabber id (jid) (e.g. "qxmpp.test1@gmail.com/resource" or qxmpptest@jabber.org/QXmpp156)

- -

-

- -

-

- - - - - - - - -

QString QXmppConfiguration::jidBare ( ) const

-

Returns the bare jabber id (jid), without the resource identifier.

-

Returns:: bare jabber id (jid) (e.g. "qxmpp.test1@gmail.com" or qxmpptest@jabber.org)

- -

-

- -

-

- - - - - - - - -

int QXmppConfiguration::keepAliveInterval ( ) const

-

Returns the keep alive interval in seconds.

-

The default value is 60 seconds.

- -

-

- -

-

- - - - - - - - -

QNetworkProxy QXmppConfiguration::networkProxy ( ) const

-

Returns the specified network proxy. The default value is QNetworkProxy::DefaultProxy that is the proxy is determined based on the application proxy set using QNetworkProxy::setApplicationProxy().

-

Returns:: QNetworkProxy

- -

-

- -

-

- - - - - - - - -

QXmppConfiguration::NonSASLAuthMechanism QXmppConfiguration::nonSASLAuthMechanism ( ) const

-

Returns the Non-SASL authentication mechanism configuration.

-

Returns:: QXmppConfiguration::NonSASLAuthMechanism

- -

-

- -

-

- - - - - - - - -

QString QXmppConfiguration::passwd ( ) const

-

Returns the password.

-

Returns:: password

- -

-

- -

-

- - - - - - - - -

int QXmppConfiguration::port ( ) const

-

Returns the port number.

-

Returns:: port number

- -

-

- -

-

- - - - - - - - -

QString QXmppConfiguration::resource ( ) const

-

Returns the resource identifier.

-

Returns:: resource identifier

- -

-

- -

-

- - - - - - - - -

QXmppConfiguration::SASLAuthMechanism QXmppConfiguration::sASLAuthMechanism ( ) const

-

Returns the SASL authentication mechanism configuration.

-

Returns:: QXmppConfiguration::SASLAuthMechanism

- -

-

- -

-

- - - - - - - - - -

void QXmppConfiguration::setAutoAcceptSubscriptions ( bool value )

-

Sets the auto-accept-subscriptions-request configuration.

-

Parameters:

- - -

value

boolean value true means that auto-accept-subscriptions-request is enabled else disabled for false

-

- -

-

- -

-

- - - - - - - - - -

void QXmppConfiguration::setAutoReconnectionEnabled ( bool value )

-

Sets the auto-reconnect-on-disconnection-on-error configuration.

-

Parameters:

- - -

value

boolean value true means that auto-reconnect is enabled else disabled for false

-

- -

-

- -

-

- - - - - - - - - -

void QXmppConfiguration::setDomain ( const QString & domain )

-

Sets the domain name.

-

Parameters:

- - -

domain

Domain name e.g. "gmail.com" and "jabber.org".

-

Note:: host name and domain name can be different for google domain name is gmail.com and host name is talk.google.com

- -

-

- -

-

- - - - - - - - - -

void QXmppConfiguration::setHost ( const QString & host )

-

Sets the host name.

-

Parameters:

- - -

host

host name of the XMPP server where connection has to be made (e.g. "jabber.org" and "talk.google.com"). It can also be an IP address in the form of a string (e.g. "192.168.1.25").

-

- -

-

- -

-

- - - - - - - - - -

void QXmppConfiguration::setIgnoreSslErrors ( bool value )

-

Specifies whether SSL errors (such as certificate validation errors) are to be ignored when connecting to an XMPP server.

- -

-

- -

-

- - - - - - - - - -

void QXmppConfiguration::setKeepAliveInterval ( int secs )

-

Specifies the interval in seconds at which keep alive (ping) packets will be sent to the server.

-

If set to zero, no keep alive packets will be sent.

-

The default value is 60 seconds.

- -

-

- -

-

- - - - - - - - - -

void QXmppConfiguration::setKeepAliveTimeout ( int secs )

-

Specifies the maximum time in seconds to wait for a keep alive response from the server before considering we are disconnected.

-

If set to zero or a value larger than the keep alive interval, no timeout will occur.

- -

-

- -

-

- - - - - - - - - -

void QXmppConfiguration::setNetworkProxy ( const QNetworkProxy & proxy )

-

Specifies the network proxy used for the connection made by QXmppClient. The default value is QNetworkProxy::DefaultProxy that is the proxy is determined based on the application proxy set using QNetworkProxy::setApplicationProxy().

-

Parameters:

- - -

proxy

QNetworkProxy

-

- -

-

- -

-

- - - - - - - - - -

void QXmppConfiguration::setNonSASLAuthMechanism ( QXmppConfiguration::NonSASLAuthMechanism mech )

-

Hints the library the Non-SASL authentication mechanism to be used for authentication.

-

Parameters:

- - -

mech

QXmppConfiguration::NonSASLAuthMechanism

-

- -

-

- -

-

- - - - - - - - - -

void QXmppConfiguration::setPasswd ( const QString & passwd )

-

Sets the password.

-

Parameters:

- - -

passwd

Password for the specified username

-

- -

-

- -

-

- - - - - - - - - -

void QXmppConfiguration::setPort ( int port )

-

Sets the port number.

-

Parameters:

- - -

port

Port number at which the XMPP server is listening. The default value is 5222.

-

- -

-

- -

-

- - - - - - - - - -

void QXmppConfiguration::setResource ( const QString & resource )

-

Sets the resource identifier.

-

Multiple resources (e.g., devices or locations) may connect simultaneously to a server on behalf of each authorized client, with each resource differentiated by the resource identifier of an XMPP address (e.g. node/home vs. node/work)

-

The default value is "QXmpp".

-

Parameters:

- - -

resource

Resource identifier of the client in connection.

-

- -

-

- -

-

- - - - - - - - - -

void QXmppConfiguration::setSASLAuthMechanism ( QXmppConfiguration::SASLAuthMechanism mech )

-

Hints the library the SASL authentication mechanism to be used for authentication.

-

Parameters:

- - -

mech

QXmppConfiguration::SASLAuthMechanism

-

- -

-

- -

-

- - - - - - - - - -

void QXmppConfiguration::setStreamSecurityMode ( QXmppConfiguration::StreamSecurityMode mode )

-

Specifies the specified security mode for the stream. The default value is QXmppConfiguration::TLSEnabled.

-

Parameters:

- - -

mode

StreamSecurityMode

-

- -

-

- -

-

- - - - - - - - - -

void QXmppConfiguration::setUser ( const QString & user )

-

Sets the username.

-

Parameters:

- - -

user

Username of the account at the specified XMPP server. It should be the name without the domain name. E.g. "qxmpp.test1" and not "qxmpp.test1@gmail.com"

-

- -

-

- -

-

- - - - - - - - - -

void QXmppConfiguration::setUseSASLAuthentication ( bool useSASL )

-

Returns the type of authentication system specified by the user.

-

Parameters:

- - -

useSASL

to hint to use SASL authentication system if available. false will specify to use NonSASL XEP-0078: Non-SASL Authentication If the specified one is not availbe, library will use the othe one

-

- -

-

- -

-

- - - - - - - - -

QXmppConfiguration::StreamSecurityMode QXmppConfiguration::streamSecurityMode ( ) const

-

Returns the specified security mode for the stream. The default value is QXmppConfiguration::TLSEnabled.

-

Returns:: StreamSecurityMode

- -

-

- -

-

- - - - - - - - -

QString QXmppConfiguration::user ( ) const

-

Returns the username.

-

Returns:: username

- -

-

- -

-

- - - - - - - - -

bool QXmppConfiguration::useSASLAuthentication ( ) const

-

Returns the type of authentication system specified by the user.

-

Returns:: true if SASL was specified else false. If the specified system is not available QXmpp will resort to the other one.

- -

-

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

QXmppConfiguration.h
QXmppConfiguration.cpp

-

QXmppConfiguration Class Reference

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation