src/common/transfer.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2013 by the Quassel Project                        *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   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.                                           *
   9  *                                                                         *
  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.                          *
  14  *                                                                         *
  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  ***************************************************************************/
  20
  21 #ifndef TRANSFER_H
  22 #define TRANSFER_H
  23
  24 #include <QHostAddress>
  25 #include <QUuid>
  26
  27 #include "syncableobject.h"
  28 #include "types.h"
  29
  30 class Transfer : public SyncableObject
  31 {
  32     Q_OBJECT
  33     SYNCABLE_OBJECT
  34
  35     Q_PROPERTY(QUuid uuid READ uuid);
  36     Q_PROPERTY(State state READ state WRITE setState NOTIFY stateChanged);
  37     Q_PROPERTY(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);
  43
  44 public:
  45     enum State {
  46         New,
  47         Pending,
  48         Transferring,
  49         Paused,
  50         Completed,
  51         Failed,
  52         Rejected
  53     };
  54     Q_ENUMS(State)
  55
  56     enum Direction {
  57         Send,
  58         Receive
  59     };
  60     Q_ENUMS(Direction)
  61
  62     Transfer(const QUuid &uuid, QObject *parent = 0); // for creating a syncable object client-side
  63     Transfer(Direction direction, const QString &nick, const QString &fileName, const QHostAddress &address, quint16 port, quint64 size = 0, QObject *parent = 0);
  64     inline virtual const QMetaObject *syncMetaObject() const { return &staticMetaObject; }
  65
  66     QUuid uuid() const;
  67     State state() const;
  68     Direction direction() const;
  69     QString fileName() const;
  70     QHostAddress address() const;
  71     quint16 port() const;
  72     quint64 fileSize() const;
  73     QString nick() const;
  74
  75 public slots:
  76     // called on the client side
  77     virtual void accept(const QString &savePath) const { Q_UNUSED(savePath); }
  78     virtual void reject() const {}
  79
  80     // called on the core side through sync calls
  81     virtual void requestAccepted(PeerPtr peer) { Q_UNUSED(peer); }
  82     virtual void requestRejected(PeerPtr peer) { Q_UNUSED(peer); }
  83
  84 signals:
  85     void stateChanged(State state);
  86     void directionChanged(Direction direction);
  87     void addressChanged(const QHostAddress &address);
  88     void portChanged(quint16 port);
  89     void fileNameChanged(const QString &fileName);
  90     void fileSizeChanged(quint64 fileSize);
  91     void nickChanged(const QString &nick);
  92
  93     void accepted(PeerPtr peer = 0) const;
  94     void rejected(PeerPtr peer = 0) const;
  95
  96 protected:
  97     void setState(State state);
  98
  99 private:
 100     void init();
 101
 102     void setDirection(Direction direction);
 103     void setAddress(const QHostAddress &address);
 104     void setPort(quint16 port);
 105     void setFileName(const QString &fileName);
 106     void setFileSize(quint64 fileSize);
 107     void setNick(const QString &nick);
 108
 109
 110     State _state;
 111     Direction _direction;
 112     QString _fileName;
 113     QHostAddress _address;
 114     quint16 _port;
 115     quint64 _fileSize;
 116     QString _nick;
 117     QUuid _uuid;
 118 };
 119
 120 #endif