/usr/include/qxmpp/QXmppTransferManager.h is in libqxmpp-dev 0.7.6-1.
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 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 | /*
* Copyright (C) 2008-2012 The QXmpp developers
*
* Author:
* Jeremy Lainé
*
* Source:
* http://code.google.com/p/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 QXMPPTRANSFERMANAGER_H
#define QXMPPTRANSFERMANAGER_H
#include <QDateTime>
#include <QSharedData>
#include <QUrl>
#include <QVariant>
#include "QXmppClientExtension.h"
class QTcpSocket;
class QXmppByteStreamIq;
class QXmppIbbCloseIq;
class QXmppIbbDataIq;
class QXmppIbbOpenIq;
class QXmppIq;
class QXmppStreamInitiationIq;
class QXmppTransferFileInfoPrivate;
class QXmppTransferJobPrivate;
class QXmppTransferManager;
class QXmppTransferManagerPrivate;
class QXMPP_EXPORT QXmppTransferFileInfo
{
public:
QXmppTransferFileInfo();
QXmppTransferFileInfo(const QXmppTransferFileInfo &other);
~QXmppTransferFileInfo();
QDateTime date() const;
void setDate(const QDateTime &date);
QByteArray hash() const;
void setHash(const QByteArray &hash);
QString name() const;
void setName(const QString &name);
QString description() const;
void setDescription(const QString &description);
qint64 size() const;
void setSize(qint64 size);
bool isNull() const;
QXmppTransferFileInfo& operator=(const QXmppTransferFileInfo &other);
bool operator==(const QXmppTransferFileInfo &other) const;
/// \cond
void parse(const QDomElement &element);
void toXml(QXmlStreamWriter *writer) const;
/// \endcond
private:
QSharedDataPointer<QXmppTransferFileInfoPrivate> d;
};
/// \brief The QXmppTransferJob class represents a single file transfer job.
///
/// \sa QXmppTransferManager
///
class QXMPP_EXPORT QXmppTransferJob : public QXmppLoggable
{
Q_OBJECT
Q_ENUMS(Direction Error State)
Q_FLAGS(Method Methods)
Q_PROPERTY(Direction direction READ direction CONSTANT)
Q_PROPERTY(QUrl localFileUrl READ localFileUrl WRITE setLocalFileUrl NOTIFY localFileUrlChanged)
Q_PROPERTY(QString jid READ jid CONSTANT)
Q_PROPERTY(Method method READ method CONSTANT)
Q_PROPERTY(State state READ state NOTIFY stateChanged)
Q_PROPERTY(QString fileName READ fileName CONSTANT)
Q_PROPERTY(qint64 fileSize READ fileSize CONSTANT)
public:
/// This enum is used to describe the direction of a transfer job.
enum Direction
{
IncomingDirection, ///< The file is being received.
OutgoingDirection, ///< The file is being sent.
};
/// This enum is used to describe the type of error encountered by a transfer job.
enum Error
{
NoError = 0, ///< No error occurred.
AbortError, ///< The file transfer was aborted.
FileAccessError, ///< An error was encountered trying to access a local file.
FileCorruptError, ///< The file is corrupt: the file size or hash do not match.
ProtocolError, ///< An error was encountered in the file transfer protocol.
};
/// This enum is used to describe a transfer method.
enum Method
{
NoMethod = 0, ///< No transfer method.
InBandMethod = 1, ///< XEP-0047: In-Band Bytestreams
SocksMethod = 2, ///< XEP-0065: SOCKS5 Bytestreams
AnyMethod = 3, ///< Any supported transfer method.
};
Q_DECLARE_FLAGS(Methods, Method)
/// This enum is used to describe the state of a transfer job.
enum State
{
OfferState = 0, ///< The transfer is being offered to the remote party.
StartState = 1, ///< The transfer is being connected.
TransferState = 2, ///< The transfer is ongoing.
FinishedState = 3, ///< The transfer is finished.
};
~QXmppTransferJob();
QXmppTransferJob::Direction direction() const;
QXmppTransferJob::Error error() const;
QString jid() const;
QXmppTransferJob::Method method() const;
QString sid() const;
qint64 speed() const;
QXmppTransferJob::State state() const;
// XEP-0096 : File transfer
QXmppTransferFileInfo fileInfo() const;
QUrl localFileUrl() const;
void setLocalFileUrl(const QUrl &localFileUrl);
/// \cond
QDateTime fileDate() const;
QByteArray fileHash() const;
QString fileName() const;
qint64 fileSize() const;
/// \endcond
signals:
/// This signal is emitted when an error is encountered while
/// processing the transfer job.
void error(QXmppTransferJob::Error error);
/// This signal is emitted when the transfer job is finished.
///
/// You can determine if the job completed successfully by testing whether
/// error() returns QXmppTransferJob::NoError.
///
/// Note: Do not delete the job in the slot connected to this signal,
/// instead use deleteLater().
void finished();
/// This signal is emitted when the local file URL changes.
void localFileUrlChanged(const QUrl &localFileUrl);
/// This signal is emitted to indicate the progress of this transfer job.
void progress(qint64 done, qint64 total);
/// This signal is emitted when the transfer job changes state.
void stateChanged(QXmppTransferJob::State state);
public slots:
void abort();
void accept(const QString &filePath);
void accept(QIODevice *output);
private slots:
void _q_terminated();
private:
QXmppTransferJob(const QString &jid, QXmppTransferJob::Direction direction, QXmppClient *client, QObject *parent);
void setState(QXmppTransferJob::State state);
void terminate(QXmppTransferJob::Error error);
QXmppTransferJobPrivate *const d;
friend class QXmppTransferManager;
friend class QXmppTransferManagerPrivate;
friend class QXmppTransferIncomingJob;
friend class QXmppTransferOutgoingJob;
};
/// \brief The QXmppTransferManager class provides support for sending and
/// receiving files.
///
/// Stream initiation is performed as described in XEP-0095: Stream Initiation
/// and XEP-0096: SI File Transfer. The actual file transfer is then performed
/// using either XEP-0065: SOCKS5 Bytestreams or XEP-0047: In-Band Bytestreams.
///
/// To make use of this manager, you need to instantiate it and load it into
/// the QXmppClient instance as follows:
///
/// \code
/// QXmppTransferManager *manager = new QXmppTransferManager;
/// client->addExtension(manager);
/// \endcode
///
/// \ingroup Managers
class QXMPP_EXPORT QXmppTransferManager : public QXmppClientExtension
{
Q_OBJECT
Q_PROPERTY(QString proxy READ proxy WRITE setProxy)
Q_PROPERTY(bool proxyOnly READ proxyOnly WRITE setProxyOnly)
Q_PROPERTY(QXmppTransferJob::Methods supportedMethods READ supportedMethods WRITE setSupportedMethods)
public:
QXmppTransferManager();
~QXmppTransferManager();
QString proxy() const;
void setProxy(const QString &proxyJid);
bool proxyOnly() const;
void setProxyOnly(bool proxyOnly);
QXmppTransferJob::Methods supportedMethods() const;
void setSupportedMethods(QXmppTransferJob::Methods methods);
/// \cond
QStringList discoveryFeatures() const;
bool handleStanza(const QDomElement &element);
/// \endcond
signals:
/// This signal is emitted when a new file transfer offer is received.
///
/// To accept the transfer job, call the job's QXmppTransferJob::accept() method.
/// To refuse the transfer job, call the job's QXmppTransferJob::abort() method.
void fileReceived(QXmppTransferJob *job);
/// This signal is emitted whenever a transfer job is started.
void jobStarted(QXmppTransferJob *job);
/// This signal is emitted whenever a transfer job is finished.
///
/// \sa QXmppTransferJob::finished()
void jobFinished(QXmppTransferJob *job);
public slots:
QXmppTransferJob *sendFile(const QString &jid, const QString &filePath, const QString &description = QString());
QXmppTransferJob *sendFile(const QString &jid, QIODevice *device, const QXmppTransferFileInfo &fileInfo, const QString &sid = QString());
protected:
/// \cond
void setClient(QXmppClient* client);
/// \endcond
private slots:
void _q_iqReceived(const QXmppIq&);
void _q_jobDestroyed(QObject *object);
void _q_jobError(QXmppTransferJob::Error error);
void _q_jobFinished();
void _q_jobStateChanged(QXmppTransferJob::State state);
void _q_socksServerConnected(QTcpSocket *socket, const QString &hostName, quint16 port);
private:
QXmppTransferManagerPrivate *d;
void byteStreamIqReceived(const QXmppByteStreamIq&);
void byteStreamResponseReceived(const QXmppIq&);
void byteStreamResultReceived(const QXmppByteStreamIq&);
void byteStreamSetReceived(const QXmppByteStreamIq&);
void ibbCloseIqReceived(const QXmppIbbCloseIq&);
void ibbDataIqReceived(const QXmppIbbDataIq&);
void ibbOpenIqReceived(const QXmppIbbOpenIq&);
void ibbResponseReceived(const QXmppIq&);
void streamInitiationIqReceived(const QXmppStreamInitiationIq&);
void streamInitiationResultReceived(const QXmppStreamInitiationIq&);
void streamInitiationSetReceived(const QXmppStreamInitiationIq&);
void socksServerSendOffer(QXmppTransferJob *job);
friend class QXmppTransferManagerPrivate;
};
Q_DECLARE_OPERATORS_FOR_FLAGS(QXmppTransferJob::Methods)
#endif
|