1 /***************************************************************************
2 * Copyright (C) 2005-2014 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 ***************************************************************************/
26 #include <QVariantList>
30 const quint32 magic = 0x42b33f00;
33 LegacyProtocol = 0x01,
34 DataStreamProtocol = 0x02
50 /*** Handshake, handled by AuthHandler ***/
52 struct HandshakeMessage {
53 inline Handler handler() const { return AuthHandler; }
57 struct RegisterClient : public HandshakeMessage
59 inline RegisterClient(const QString &clientVersion, const QString &buildDate, bool sslSupported = false)
60 : clientVersion(clientVersion)
61 , buildDate(buildDate)
62 , sslSupported(sslSupported) {}
64 QString clientVersion;
67 // this is only used by the LegacyProtocol in compat mode
72 struct ClientDenied : public HandshakeMessage
74 inline ClientDenied(const QString &errorString)
75 : errorString(errorString) {}
81 struct ClientRegistered : public HandshakeMessage
83 inline ClientRegistered(quint32 coreFeatures, bool coreConfigured, const QVariantList &backendInfo, bool sslSupported, const QString &coreInfo)
84 : coreFeatures(coreFeatures)
85 , coreConfigured(coreConfigured)
86 , backendInfo(backendInfo)
87 , sslSupported(sslSupported)
93 QVariantList backendInfo; // TODO: abstract this better
95 // this is only used by the LegacyProtocol in compat mode
101 struct SetupData : public HandshakeMessage
103 inline SetupData(const QString &adminUser, const QString &adminPassword, const QString &backend, const QVariantMap &setupData)
104 : adminUser(adminUser), adminPassword(adminPassword), backend(backend), setupData(setupData) {}
107 QString adminPassword;
109 QVariantMap setupData;
113 struct SetupFailed : public HandshakeMessage
115 inline SetupFailed(const QString &errorString)
116 : errorString(errorString) {}
122 struct SetupDone : public HandshakeMessage
124 inline SetupDone() {}
128 struct Login : public HandshakeMessage
130 inline Login(const QString &user, const QString &password)
131 : user(user), password(password) {}
138 struct LoginFailed : public HandshakeMessage
140 inline LoginFailed(const QString &errorString)
141 : errorString(errorString) {}
147 struct LoginSuccess : public HandshakeMessage
149 inline LoginSuccess() {}
153 // TODO: more generic format
154 struct SessionState : public HandshakeMessage
156 inline SessionState() {} // needed for QMetaType (for the mono client)
157 inline SessionState(const QVariantList &identities, const QVariantList &bufferInfos, const QVariantList &networkIds)
158 : identities(identities), bufferInfos(bufferInfos), networkIds(networkIds) {}
160 QVariantList identities;
161 QVariantList bufferInfos;
162 QVariantList networkIds;
165 /*** handled by SignalProxy ***/
167 struct SignalProxyMessage
169 inline Handler handler() const { return SignalProxy; }
173 struct SyncMessage : public SignalProxyMessage
175 inline SyncMessage(const QByteArray &className, const QString &objectName, const QByteArray &slotName, const QVariantList ¶ms)
176 : className(className), objectName(objectName), slotName(slotName), params(params) {}
178 QByteArray className;
185 struct RpcCall : public SignalProxyMessage
187 inline RpcCall(const QByteArray &slotName, const QVariantList ¶ms)
188 : slotName(slotName), params(params) {}
195 struct InitRequest : public SignalProxyMessage
197 inline InitRequest(const QByteArray &className, const QString &objectName)
198 : className(className), objectName(objectName) {}
200 QByteArray className;
205 struct InitData : public SignalProxyMessage
207 inline InitData(const QByteArray &className, const QString &objectName, const QVariantMap &initData)
208 : className(className), objectName(objectName), initData(initData) {}
210 QByteArray className;
212 QVariantMap initData;
216 /*** handled by RemoteConnection ***/
220 inline HeartBeat(const QDateTime ×tamp) : timestamp(timestamp) {}
226 struct HeartBeatReply
228 inline HeartBeatReply(const QDateTime ×tamp) : timestamp(timestamp) {}