/usr/include/qxmpp/QXmppClient.h is in libqxmpp-dev 0.9.3-1build3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 | /*
* Copyright (C) 2008-2014 The QXmpp developers
*
* Author:
* Manjeet Dahiya
*
* Source:
* https://github.com/qxmpp-project/qxmpp
*
* This file is a part of QXmpp library.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
*/
#ifndef QXMPPCLIENT_H
#define QXMPPCLIENT_H
#include <QObject>
#include <QAbstractSocket>
#include "QXmppConfiguration.h"
#include "QXmppLogger.h"
#include "QXmppPresence.h"
class QSslError;
class QXmppClientExtension;
class QXmppClientPrivate;
class QXmppPresence;
class QXmppMessage;
class QXmppIq;
class QXmppStream;
// managers
class QXmppDiscoveryIq;
class QXmppRosterManager;
class QXmppVCardManager;
class QXmppVersionManager;
/// \defgroup Core
/// \defgroup Managers
/// \brief The QXmppClient class is the main class for using QXmpp.
///
/// It provides the user all the required functionality to connect to the
/// server and perform operations afterwards.
///
/// This class will provide the handle/reference to QXmppRosterManager
/// (roster management), QXmppVCardManager (vCard manager), and
/// QXmppVersionManager (software version information).
///
/// By default, the client will automatically try reconnecting to the server.
/// You can change this a behaviour using
/// QXmppConfiguration::setAutoReconnectionEnabled().
///
/// Not all the managers or extensions have been enabled by default. One can
/// enable/disable the managers using the funtions addExtension() and
/// removeExtension(). findExtension() can be used to find reference/pointer to
/// particular instansiated and enabled manager.
///
/// List of managers enabled by default:
/// - QXmppRosterManager
/// - QXmppVCardManager
/// - QXmppVersionManager
/// - QXmppDiscoveryManager
/// - QXmppEntityTimeManager
///
/// \ingroup Core
class QXMPP_EXPORT QXmppClient : public QXmppLoggable
{
Q_OBJECT
Q_ENUMS(Error State)
Q_PROPERTY(QXmppLogger* logger READ logger WRITE setLogger NOTIFY loggerChanged)
Q_PROPERTY(State state READ state NOTIFY stateChanged)
public:
/// An enumeration for type of error.
/// Error could come due a TCP socket or XML stream or due to various stanzas.
enum Error
{
NoError, ///< No error.
SocketError, ///< Error due to TCP socket.
KeepAliveError, ///< Error due to no response to a keep alive.
XmppStreamError ///< Error due to XML stream.
};
/// This enumeration describes a client state.
enum State
{
DisconnectedState, ///< Disconnected from the server.
ConnectingState, ///< Trying to connect to the server.
ConnectedState ///< Connected to the server.
};
QXmppClient(QObject *parent = 0);
~QXmppClient();
bool addExtension(QXmppClientExtension* extension);
bool insertExtension(int index, QXmppClientExtension* extension);
bool removeExtension(QXmppClientExtension* extension);
QList<QXmppClientExtension*> extensions();
/// \brief Returns the extension which can be cast into type T*, or 0
/// if there is no such extension.
///
/// Usage example:
/// \code
/// QXmppDiscoveryManager* ext = client->findExtension<QXmppDiscoveryManager>();
/// if(ext)
/// {
/// //extension found, do stuff...
/// }
/// \endcode
///
template<typename T>
T* findExtension()
{
QList<QXmppClientExtension*> list = extensions();
for (int i = 0; i < list.size(); ++i)
{
T* extension = qobject_cast<T*>(list.at(i));
if(extension)
return extension;
}
return 0;
}
bool isAuthenticated() const;
bool isConnected() const;
QXmppPresence clientPresence() const;
void setClientPresence(const QXmppPresence &presence);
QXmppConfiguration &configuration();
QXmppLogger *logger() const;
void setLogger(QXmppLogger *logger);
QAbstractSocket::SocketError socketError();
QString socketErrorString() const;
State state() const;
QXmppStanza::Error::Condition xmppStreamError();
QXmppRosterManager& rosterManager();
QXmppVCardManager& vCardManager();
QXmppVersionManager& versionManager();
signals:
/// This signal is emitted when the client connects successfully to the XMPP
/// server i.e. when a successful XMPP connection is established.
/// XMPP Connection involves following sequential steps:
/// - TCP socket connection
/// - Client sends start stream
/// - Server sends start stream
/// - TLS negotiation (encryption)
/// - Authentication
/// - Resource binding
/// - Session establishment
///
/// After all these steps a successful XMPP connection is established and
/// connected() signal is emitted.
///
/// After the connected() signal is emitted QXmpp will send the roster request
/// to the server. On receiving the roster, QXmpp will emit
/// QXmppRosterManager::rosterReceived(). After this signal, QXmppRosterManager object gets
/// populated and you can use rosterManager() to get the handle of QXmppRosterManager object.
///
void connected();
/// This signal is emitted when the XMPP connection disconnects.
///
void disconnected();
/// This signal is emitted when the XMPP connection encounters any error.
/// The QXmppClient::Error parameter specifies the type of error occurred.
/// It could be due to TCP socket or the xml stream or the stanza.
/// Depending upon the type of error occurred use the respective get function to
/// know the error.
void error(QXmppClient::Error);
/// This signal is emitted when the logger changes.
void loggerChanged(QXmppLogger *logger);
/// Notifies that an XMPP message stanza is received. The QXmppMessage
/// parameter contains the details of the message sent to this client.
/// In other words whenever someone sends you a message this signal is
/// emitted.
void messageReceived(const QXmppMessage &message);
/// Notifies that an XMPP presence stanza is received. The QXmppPresence
/// parameter contains the details of the presence sent to this client.
/// This signal is emitted when someone login/logout or when someone's status
/// changes Busy, Idle, Invisible etc.
void presenceReceived(const QXmppPresence &presence);
/// Notifies that an XMPP iq stanza is received. The QXmppIq
/// parameter contains the details of the iq sent to this client.
/// IQ stanzas provide a structured request-response mechanism. Roster
/// management, setting-getting vCards etc is done using iq stanzas.
void iqReceived(const QXmppIq &iq);
/// This signal is emitted to indicate that one or more SSL errors were
/// encountered while establishing the identity of the server.
void sslErrors(const QList<QSslError> &errors);
/// This signal is emitted when the client state changes.
void stateChanged(QXmppClient::State state);
public slots:
void connectToServer(const QXmppConfiguration&,
const QXmppPresence& initialPresence =
QXmppPresence());
void connectToServer(const QString &jid,
const QString &password);
void disconnectFromServer();
bool sendPacket(const QXmppStanza&);
void sendMessage(const QString& bareJid, const QString& message);
private slots:
void _q_elementReceived(const QDomElement &element, bool &handled);
void _q_reconnect();
void _q_socketStateChanged(QAbstractSocket::SocketState state);
void _q_streamConnected();
void _q_streamDisconnected();
void _q_streamError(QXmppClient::Error error);
private:
QXmppClientPrivate * const d;
};
#endif // QXMPPCLIENT_H
|