QXmpp  Version:0.9.3
Public Member Functions | Protected Member Functions | Friends
QXmppServerExtension Class Reference

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

#include <QXmppServerExtension.h>

Inheritance diagram for QXmppServerExtension:
QXmppLoggable

List of all members.

Public Member Functions

virtual QString extensionName () const
virtual int extensionPriority () const
virtual QStringList discoveryFeatures () const
virtual QStringList discoveryItems () 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 ()
 Stops the extension.

Protected Member Functions

QXmppServerserver () const
 Returns the server which loaded this extension.

Friends

class QXmppServer

Detailed Description

The QXmppServerExtension class is the base class for QXmppServer extensions.

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

QStringList QXmppServerExtension::discoveryFeatures ( ) const [virtual]

Returns the discovery features to add to the server.

QStringList QXmppServerExtension::discoveryItems ( ) const [virtual]

Returns the discovery items to add to the server.

QString QXmppServerExtension::extensionName ( ) const [virtual]

Returns the extension's name.

int QXmppServerExtension::extensionPriority ( ) const [virtual]

Returns the extension's priority.

Higher priority extensions are called first when handling incoming stanzas.

The default implementation returns 0.

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

Handles an incoming XMPP stanza.

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

Parameters:
stanzaThe received stanza.
QSet< QString > QXmppServerExtension::presenceSubscribers ( const QString &  jid) [virtual]

Returns the list of subscribers for the given JID.

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

Returns the list of subscriptions for the given JID.

Parameters:
jid
bool QXmppServerExtension::start ( ) [virtual]

Starts the extension.

Return true if the extension was started, false otherwise.


The documentation for this class was generated from the following files:
 All Classes Functions Enumerations Enumerator Properties