1 /***************************************************************************
2 * Copyright (C) 2005-2016 by the Quassel Project *
3 * devel@quassel-irc.org *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) version 3. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
24 #include <QHostAddress>
28 #include "syncableobject.h"
30 class Transfer : public SyncableObject
35 Q_PROPERTY(QUuid uuid READ uuid);
36 Q_PROPERTY(Transfer::Status status READ status WRITE setStatus NOTIFY statusChanged);
37 Q_PROPERTY(Transfer::Direction direction READ direction WRITE setDirection NOTIFY directionChanged);
38 Q_PROPERTY(QHostAddress address READ address WRITE setAddress NOTIFY addressChanged);
39 Q_PROPERTY(quint16 port READ port WRITE setPort NOTIFY portChanged);
40 Q_PROPERTY(QString fileName READ fileName WRITE setFileName NOTIFY fileNameChanged);
41 Q_PROPERTY(quint64 fileSize READ fileSize WRITE setFileSize NOTIFY fileSizeChanged);
42 Q_PROPERTY(QString nick READ nick WRITE setNick NOTIFY nickChanged);
57 enum class Direction {
63 Transfer(const QUuid &uuid, QObject *parent = 0); // for creating a syncable object client-side
64 Transfer(Direction direction, const QString &nick, const QString &fileName, const QHostAddress &address, quint16 port, quint64 size = 0, QObject *parent = 0);
65 inline const QMetaObject *syncMetaObject() const override { return &staticMetaObject; }
68 Status status() const;
69 QString prettyStatus() const;
70 Direction direction() const;
71 QString fileName() const;
72 QHostAddress address() const;
74 quint64 fileSize() const;
77 virtual quint64 transferred() const = 0;
80 // called on the client side
81 virtual void accept(const QString &savePath) const { Q_UNUSED(savePath); }
82 virtual void reject() const {}
84 // called on the core side through sync calls
85 virtual void requestAccepted(PeerPtr peer) { Q_UNUSED(peer); }
86 virtual void requestRejected(PeerPtr peer) { Q_UNUSED(peer); }
89 void statusChanged(Transfer::Status state);
90 void directionChanged(Transfer::Direction direction);
91 void addressChanged(const QHostAddress &address);
92 void portChanged(quint16 port);
93 void fileNameChanged(const QString &fileName);
94 void fileSizeChanged(quint64 fileSize);
95 void transferredChanged(quint64 transferred);
96 void nickChanged(const QString &nick);
98 void error(const QString &errorString);
100 void accepted(PeerPtr peer = 0) const;
101 void rejected(PeerPtr peer = 0) const;
104 void setStatus(Transfer::Status status);
105 void setError(const QString &errorString);
107 // called on the client side through sync calls
108 virtual void dataReceived(PeerPtr, const QByteArray &data) { Q_UNUSED(data); }
110 virtual void cleanUp() = 0;
115 void setDirection(Direction direction);
116 void setAddress(const QHostAddress &address);
117 void setPort(quint16 port);
118 void setFileName(const QString &fileName);
119 void setFileSize(quint64 fileSize);
120 void setNick(const QString &nick);
124 Direction _direction;
126 QHostAddress _address;
133 Q_DECLARE_METATYPE(Transfer::Status)
134 Q_DECLARE_METATYPE(Transfer::Direction)
136 QDataStream &operator<<(QDataStream &out, Transfer::Status state);
137 QDataStream &operator>>(QDataStream &in, Transfer::Status &state);
138 QDataStream &operator<<(QDataStream &out, Transfer::Direction direction);
139 QDataStream &operator>>(QDataStream &in, Transfer::Direction &direction);