Implement core-side highlights
[quassel.git] / src / common / internalpeer.h
1 /***************************************************************************
2  *   Copyright (C) 2005-2016 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 INTERNALPEER_H
22 #define INTERNALPEER_H
23
24 #include "peer.h"
25 #include "protocol.h"
26 #include "signalproxy.h"
27
28 class QEvent;
29
30 class InternalPeer : public Peer
31 {
32     Q_OBJECT
33
34 public:
35     enum EventType {
36         SyncMessageEvent = QEvent::User,
37         RpcCallEvent,
38         InitRequestEvent,
39         InitDataEvent
40     };
41
42     InternalPeer(QObject *parent = 0);
43     virtual ~InternalPeer();
44
45     Protocol::Type protocol() const { return Protocol::InternalProtocol; }
46     QString description() const;
47
48     virtual QString address() const;
49     virtual quint16 port() const;
50
51     SignalProxy *signalProxy() const;
52     void setSignalProxy(SignalProxy *proxy);
53
54     InternalPeer *peer() const;
55     void setPeer(InternalPeer *peer);
56
57     bool isOpen() const;
58     bool isSecure() const;
59     bool isLocal() const;
60
61     int lag() const;
62
63     void dispatch(const Protocol::SyncMessage &msg);
64     void dispatch(const Protocol::RpcCall &msg);
65     void dispatch(const Protocol::InitRequest &msg);
66     void dispatch(const Protocol::InitData &msg);
67
68     /* These are not needed for InternalPeer */
69     void dispatch(const Protocol::RegisterClient &) {}
70     void dispatch(const Protocol::ClientDenied &) {}
71     void dispatch(const Protocol::ClientRegistered &) {}
72     void dispatch(const Protocol::SetupData &) {}
73     void dispatch(const Protocol::SetupFailed &) {}
74     void dispatch(const Protocol::SetupDone &) {}
75     void dispatch(const Protocol::Login &) {}
76     void dispatch(const Protocol::LoginFailed &) {}
77     void dispatch(const Protocol::LoginSuccess &) {}
78     void dispatch(const Protocol::SessionState &) {}
79
80 public slots:
81     void close(const QString &reason = QString());
82
83 protected:
84     void customEvent(QEvent *event);
85
86 private slots:
87     void peerDisconnected();
88
89 private:
90     template<class T>
91     void dispatch(EventType eventType, const T &msg);
92
93 private:
94     SignalProxy *_proxy;
95     InternalPeer *_peer;
96     bool _isOpen;
97 };
98
99
100 #endif