QXmpp  Version:0.9.3
Public Slots | Signals | Public Member Functions | Properties | Friends
QXmppServer Class Reference

The QXmppServer class represents an XMPP server. More...

#include <QXmppServer.h>

Inheritance diagram for QXmppServer:
QXmppLoggable

List of all members.

Public Slots

void handleElement (const QDomElement &element)
 Handle an incoming XML element.

Signals

void clientConnected (const QString &jid)
 This signal is emitted when a client has connected.
void clientDisconnected (const QString &jid)
 This signal is emitted when a client has disconnected.
void loggerChanged (QXmppLogger *logger)
 This signal is emitted when the logger changes.

Public Member Functions

 QXmppServer (QObject *parent=0)
 ~QXmppServer ()
void addExtension (QXmppServerExtension *extension)
QList< QXmppServerExtension * > extensions ()
QString domain () const
void setDomain (const QString &domain)
QXmppLoggerlogger ()
void setLogger (QXmppLogger *logger)
QXmppPasswordCheckerpasswordChecker ()
void setPasswordChecker (QXmppPasswordChecker *checker)
QVariantMap statistics () const
 Returns the statistics for the server.
void addCaCertificates (const QString &caCertificates)
void setLocalCertificate (const QString &path)
void setLocalCertificate (const QSslCertificate &certificate)
void setPrivateKey (const QString &path)
void setPrivateKey (const QSslKey &key)
void close ()
bool listenForClients (const QHostAddress &address=QHostAddress::Any, quint16 port=5222)
bool listenForServers (const QHostAddress &address=QHostAddress::Any, quint16 port=5269)
bool sendElement (const QDomElement &element)
bool sendPacket (const QXmppStanza &stanza)
void addIncomingClient (QXmppIncomingClient *stream)

Properties

QXmppLogger logger

Friends

class QXmppServerPrivate

Detailed Description

The QXmppServer class represents an XMPP server.

It provides support for both client-to-server and server-to-server communications, SSL encryption and logging facilities.

QXmppServer comes with a number of modules for service discovery, XMPP ping, statistics and file transfer proxy support. You can write your own extensions for QXmppServer by subclassing QXmppServerExtension.


Constructor & Destructor Documentation

QXmppServer::QXmppServer ( QObject *  parent = 0)

Constructs a new XMPP server instance.

Parameters:
parent

Destroys an XMPP server instance.


Member Function Documentation

void QXmppServer::addCaCertificates ( const QString &  path)

Sets the path for additional SSL CA certificates.

Parameters:
path

Registers a new extension with the server.

Parameters:
extension

Add a new incoming client stream.

This method can be used for instance to implement BOSH support as a server extension.

Closes the server.

QString QXmppServer::domain ( ) const

Returns the server's domain.

Returns the list of loaded extensions.

bool QXmppServer::listenForClients ( const QHostAddress &  address = QHostAddress::Any,
quint16  port = 5222 
)

Listen for incoming XMPP client connections.

Parameters:
address
port
bool QXmppServer::listenForServers ( const QHostAddress &  address = QHostAddress::Any,
quint16  port = 5269 
)

Listen for incoming XMPP server connections.

Parameters:
address
port

Returns the password checker used to verify client credentials.

bool QXmppServer::sendElement ( const QDomElement &  element)

Route an XMPP stanza.

Parameters:
element
bool QXmppServer::sendPacket ( const QXmppStanza packet)

Route an XMPP packet.

Parameters:
packet
void QXmppServer::setDomain ( const QString &  domain)

Sets the server's domain.

Parameters:
domain
void QXmppServer::setLocalCertificate ( const QString &  path)

Sets the path for the local SSL certificate.

Parameters:
path
void QXmppServer::setLocalCertificate ( const QSslCertificate &  certificate)

Sets the local SSL certificate

Parameters:
certificate
void QXmppServer::setLogger ( QXmppLogger logger)

Sets the QXmppLogger associated with the server.

Parameters:
logger

Sets the password checker used to verify client credentials.

Parameters:
checker
void QXmppServer::setPrivateKey ( const QString &  path)

Sets the path for the local SSL private key.

Parameters:
path
void QXmppServer::setPrivateKey ( const QSslKey &  key)

Sets the local SSL private key.

Parameters:
key

Property Documentation

Returns the QXmppLogger associated with the server.


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