QXmppServerExtension Class

The QXmppServerExtension class is the base class for QXmppServer extensions. More...

Header: #include <QXmppServerExtension.h>
Inherits: QXmppLoggable

Public Functions

virtual QStringList discoveryFeatures() const
virtual QStringList discoveryItems() const
virtual QString extensionName() const
virtual int extensionPriority() const
virtual bool handleStanza(const QDomElement &stanza)
virtual QSet<QString> presenceSubscribers(const QString &jid)
virtual QSet<QString> presenceSubscriptions(const QString &jid)
virtual bool start()
virtual void stop()

Protected Functions

QXmppServer *server() const

Detailed Description

If you want to extend QXmppServer, for instance to support an IQ type which is not natively supported, you can subclass QXmppServerExtension and implement handleStanza(). You can then add your extension to the client instance using QXmppServer::addExtension().

Member Function Documentation

[virtual] QStringList QXmppServerExtension::discoveryFeatures() const

Returns the discovery features to add to the server.

[virtual] QStringList QXmppServerExtension::discoveryItems() const

Returns the discovery items to add to the server.

[virtual] QString QXmppServerExtension::extensionName() const

Returns the extension's name.

[virtual] int QXmppServerExtension::extensionPriority() const

Returns the extension's priority.

Higher priority extensions are called first when handling incoming stanzas.

The default implementation returns 0.

[virtual] bool QXmppServerExtension::handleStanza(const QDomElement &stanza)

Handles an incoming XMPP stanza.

Returns true if no further processing should occur, false otherwise.

[virtual] QSet<QString> QXmppServerExtension::presenceSubscribers(const QString &jid)

Returns the list of subscribers for the given JID.

jid.

[virtual] QSet<QString> QXmppServerExtension::presenceSubscriptions(const QString &jid)

Returns the list of subscriptions for the given JID.

jid.

[protected] QXmppServer *QXmppServerExtension::server() const

Returns the server which loaded this extension.

[virtual] bool QXmppServerExtension::start()

Starts the extension.

Return true if the extension was started, false otherwise.

[virtual] void QXmppServerExtension::stop()

Stops the extension.