Quassel IRC  Pre-Release
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros
peer.h
Go to the documentation of this file.
1 /***************************************************************************
2  * Copyright (C) 2005-2015 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 PEER_H
22 #define PEER_H
23 
24 #include <QAbstractSocket>
25 #include <QDataStream>
26 #include <QPointer>
27 
28 #include "authhandler.h"
29 #include "protocol.h"
30 #include "signalproxy.h"
31 
32 class Peer : public QObject
33 {
34  Q_OBJECT
35 
36 public:
37  Peer(AuthHandler *authHandler, QObject *parent = 0);
38 
39  virtual Protocol::Type protocol() const = 0;
40  virtual QString description() const = 0;
41 
42  virtual SignalProxy *signalProxy() const = 0;
43  virtual void setSignalProxy(SignalProxy *proxy) = 0;
44 
45  AuthHandler *authHandler() const;
46 
47  virtual bool isOpen() const = 0;
48  virtual bool isSecure() const = 0;
49  virtual bool isLocal() const = 0;
50 
51  virtual int lag() const = 0;
52 
53 public slots:
54  /* Handshake messages */
55  virtual void dispatch(const Protocol::RegisterClient &) = 0;
56  virtual void dispatch(const Protocol::ClientDenied &) = 0;
57  virtual void dispatch(const Protocol::ClientRegistered &) = 0;
58  virtual void dispatch(const Protocol::SetupData &) = 0;
59  virtual void dispatch(const Protocol::SetupFailed &) = 0;
60  virtual void dispatch(const Protocol::SetupDone &) = 0;
61  virtual void dispatch(const Protocol::Login &) = 0;
62  virtual void dispatch(const Protocol::LoginFailed &) = 0;
63  virtual void dispatch(const Protocol::LoginSuccess &) = 0;
64  virtual void dispatch(const Protocol::SessionState &) = 0;
65 
66  /* Sigproxy messages */
67  virtual void dispatch(const Protocol::SyncMessage &) = 0;
68  virtual void dispatch(const Protocol::RpcCall &) = 0;
69  virtual void dispatch(const Protocol::InitRequest &) = 0;
70  virtual void dispatch(const Protocol::InitData &) = 0;
71 
72  virtual void close(const QString &reason = QString()) = 0;
73 
74 signals:
75  void disconnected();
76  void secureStateChanged(bool secure = true);
77  void lagUpdated(int msecs);
78 
79 protected:
80  template<typename T>
81  void handle(const T &protoMessage);
82 
83 private:
84  QPointer<AuthHandler> _authHandler;
85 };
86 
87 // We need to special-case Peer* in attached signals/slots, so typedef it for the meta type system
88 typedef Peer * PeerPtr;
90 
91 QDataStream &operator<<(QDataStream &out, PeerPtr ptr);
92 QDataStream &operator>>(QDataStream &in, PeerPtr &ptr);
93 
94 
95 // Template method needed in the header
96 template<typename T> inline
97 void Peer::handle(const T &protoMessage)
98 {
99  switch(protoMessage.handler()) {
101  if (!signalProxy()) {
102  qWarning() << Q_FUNC_INFO << "Cannot handle message without a SignalProxy!";
103  return;
104  }
105  signalProxy()->handle(this, protoMessage);
106  break;
107 
109  if (!authHandler()) {
110  qWarning() << Q_FUNC_INFO << "Cannot handle auth messages without an active AuthHandler!";
111  return;
112  }
113  authHandler()->handle(protoMessage);
114  break;
115 
116  default:
117  qWarning() << Q_FUNC_INFO << "Unknown handler for protocol message!";
118  return;
119  }
120 }
121 
122 #endif