src/common/remotepeer.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2018 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 REMOTEPEER_H
  22 #define REMOTEPEER_H
  23
  24 #include <QDateTime>
  25
  26 #include "compressor.h"
  27 #include "peer.h"
  28 #include "protocol.h"
  29 #include "signalproxy.h"
  30
  31 class QTimer;
  32
  33 class AuthHandler;
  34
  35 class RemotePeer : public Peer
  36 {
  37     Q_OBJECT
  38
  39 public:
  40     // import the virtuals from the baseclass
  41     using Peer::handle;
  42     using Peer::dispatch;
  43
  44     RemotePeer(AuthHandler *authHandler, QTcpSocket *socket, Compressor::CompressionLevel level, QObject *parent = 0);
  45
  46     void setSignalProxy(SignalProxy *proxy);
  47
  48     virtual QString protocolName() const = 0;
  49     virtual QString description() const;
  50     virtual quint16 enabledFeatures() const { return 0; }
  51
  52     virtual QString address() const;
  53     virtual quint16 port() const;
  54
  55     bool isOpen() const;
  56     bool isSecure() const;
  57     bool isLocal() const;
  58
  59     int lag() const;
  60
  61     bool compressionEnabled() const;
  62     void setCompressionEnabled(bool enabled);
  63
  64     QTcpSocket *socket() const;
  65
  66 public slots:
  67     void close(const QString &reason = QString());
  68
  69 signals:
  70     void transferProgress(int current, int max);
  71     void socketError(QAbstractSocket::SocketError error, const QString &errorString);
  72     void statusMessage(const QString &msg);
  73
  74 protected:
  75     SignalProxy *signalProxy() const;
  76
  77     void writeMessage(const QByteArray &msg);
  78     virtual void processMessage(const QByteArray &msg) = 0;
  79
  80     // These protocol messages get handled internally and won't reach SignalProxy
  81     void handle(const Protocol::HeartBeat &heartBeat);
  82     void handle(const Protocol::HeartBeatReply &heartBeatReply);
  83     virtual void dispatch(const Protocol::HeartBeat &msg) = 0;
  84     virtual void dispatch(const Protocol::HeartBeatReply &msg) = 0;
  85
  86 protected slots:
  87     virtual void onSocketStateChanged(QAbstractSocket::SocketState state);
  88     virtual void onSocketError(QAbstractSocket::SocketError error);
  89
  90 private slots:
  91     void onReadyRead();
  92     void onCompressionError(Compressor::Error error);
  93
  94     void sendHeartBeat();
  95     void changeHeartBeatInterval(int secs);
  96
  97 private:
  98     bool readMessage(QByteArray &msg);
  99
 100 private:
 101     QTcpSocket *_socket;
 102     Compressor *_compressor;
 103     SignalProxy *_signalProxy;
 104     QTimer *_heartBeatTimer;
 105     int _heartBeatCount;
 106     int _lag;
 107     quint32 _msgSize;
 108 };
 109
 110 #endif