1 /***************************************************************************
2 * Copyright (C) 2005-2012 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 ***************************************************************************/
24 #include <QAbstractSocket>
29 #include <QVariantMap>
39 class SignalProxy : public QObject
59 RemovePeerEvent = QEvent::User
62 SignalProxy(QObject *parent);
63 SignalProxy(ProxyMode mode, QObject *parent);
64 virtual ~SignalProxy();
66 void setProxyMode(ProxyMode mode);
67 inline ProxyMode proxyMode() const { return _proxyMode; }
69 void setHeartBeatInterval(int secs);
70 inline int heartBeatInterval() const { return _heartBeatInterval; }
71 void setMaxHeartBeatCount(int max);
72 inline int maxHeartBeatCount() const { return _maxHeartBeatCount; }
74 bool addPeer(AbstractPeer *peer);
76 bool attachSignal(QObject *sender, const char *signal, const QByteArray &sigName = QByteArray());
77 bool attachSlot(const QByteArray &sigName, QObject *recv, const char *slot);
79 void synchronize(SyncableObject *obj);
80 void stopSynchronize(SyncableObject *obj);
82 class ExtendedMetaObject;
83 ExtendedMetaObject *extendedMetaObject(const QMetaObject *meta) const;
84 ExtendedMetaObject *createExtendedMetaObject(const QMetaObject *meta, bool checkConflicts = false);
85 inline ExtendedMetaObject *extendedMetaObject(const QObject *obj) const { return extendedMetaObject(metaObject(obj)); }
86 inline ExtendedMetaObject *createExtendedMetaObject(const QObject *obj, bool checkConflicts = false) { return createExtendedMetaObject(metaObject(obj), checkConflicts); }
88 bool isSecure() const { return _secure; }
89 void dumpProxyStats();
90 void dumpSyncMap(SyncableObject *object);
91 inline int peerCount() const { return _peers.size(); }
94 void detachObject(QObject *obj);
95 void detachSignals(QObject *sender);
96 void detachSlots(QObject *receiver);
99 void customEvent(QEvent *event);
100 void sync_call__(const SyncableObject *obj, ProxyMode modeType, const char *funcname, va_list ap);
101 void renameObject(const SyncableObject *obj, const QString &newname, const QString &oldname);
104 void removePeerBySender();
105 void objectRenamed(const QByteArray &classname, const QString &newname, const QString &oldname);
106 void updateSecureState();
109 void peerRemoved(SignalProxy::AbstractPeer *peer);
112 void objectInitialized(SyncableObject *);
113 void heartBeatIntervalChanged(int secs);
114 void maxHeartBeatCountChanged(int max);
115 void lagUpdated(int lag);
116 void secureStateChanged(bool);
120 class PeerMessageEvent;
126 static const QMetaObject *metaObject(const QObject *obj);
128 void removePeer(AbstractPeer *peer);
129 void removeAllPeers();
132 void dispatch(const T &protoMessage);
134 void handle(AbstractPeer *peer, const SyncMessage &syncMessage);
135 void handle(AbstractPeer *peer, const RpcCall &rpcCall);
136 void handle(AbstractPeer *peer, const InitRequest &initRequest);
137 void handle(AbstractPeer *peer, const InitData &initData);
139 bool invokeSlot(QObject *receiver, int methodId, const QVariantList ¶ms, QVariant &returnValue);
140 bool invokeSlot(QObject *receiver, int methodId, const QVariantList ¶ms = QVariantList());
142 void requestInit(SyncableObject *obj);
143 QVariantMap initData(SyncableObject *obj) const;
144 void setInitData(SyncableObject *obj, const QVariantMap &properties);
146 static void disconnectDevice(QIODevice *dev, const QString &reason = QString());
148 QSet<AbstractPeer *> _peers;
150 // containg a list of argtypes for fast access
151 QHash<const QMetaObject *, ExtendedMetaObject *> _extendedMetaObjects;
153 // SignalRelay for all manually attached signals
154 SignalRelay *_signalRelay;
156 // RPC function -> (object, slot ID)
157 typedef QPair<QObject *, int> MethodId;
158 typedef QMultiHash<QByteArray, MethodId> SlotHash;
159 SlotHash _attachedSlots;
162 typedef QHash<QString, SyncableObject *> ObjectId;
163 QHash<QByteArray, ObjectId> _syncSlave;
165 ProxyMode _proxyMode;
166 int _heartBeatInterval;
167 int _maxHeartBeatCount;
169 bool _secure; // determines if all connections are in a secured state (using ssl or internal connections)
171 friend class SignalRelay;
172 friend class SyncableObject;
173 friend class InternalConnection;
174 friend class RemoteConnection;
178 // ==================================================
179 // ExtendedMetaObject
180 // ==================================================
181 class SignalProxy::ExtendedMetaObject
183 class MethodDescriptor
186 MethodDescriptor(const QMetaMethod &method);
187 MethodDescriptor() : _returnType(-1), _minArgCount(-1), _receiverMode(SignalProxy::Client) {}
189 inline const QByteArray &methodName() const { return _methodName; }
190 inline const QList<int> &argTypes() const { return _argTypes; }
191 inline int returnType() const { return _returnType; }
192 inline int minArgCount() const { return _minArgCount; }
193 inline SignalProxy::ProxyMode receiverMode() const { return _receiverMode; }
196 QByteArray _methodName;
197 QList<int> _argTypes;
200 SignalProxy::ProxyMode _receiverMode; // Only acceptable as a Sync Call if the receiving SignalProxy is in this mode.
205 ExtendedMetaObject(const QMetaObject *meta, bool checkConflicts);
207 inline const QByteArray &methodName(int methodId) { return methodDescriptor(methodId).methodName(); }
208 inline const QList<int> &argTypes(int methodId) { return methodDescriptor(methodId).argTypes(); }
209 inline int returnType(int methodId) { return methodDescriptor(methodId).returnType(); }
210 inline int minArgCount(int methodId) { return methodDescriptor(methodId).minArgCount(); }
211 inline SignalProxy::ProxyMode receiverMode(int methodId) { return methodDescriptor(methodId).receiverMode(); }
213 inline int methodId(const QByteArray &methodName) { return _methodIds.contains(methodName) ? _methodIds[methodName] : -1; }
215 inline int updatedRemotelyId() { return _updatedRemotelyId; }
217 inline const QHash<QByteArray, int> &slotMap() { return _methodIds; }
218 const QHash<int, int> &receiveMap();
220 const QMetaObject *metaObject() const { return _meta; }
222 static QByteArray methodName(const QMetaMethod &method);
223 static QString methodBaseName(const QMetaMethod &method);
226 const MethodDescriptor &methodDescriptor(int methodId);
228 const QMetaObject *_meta;
229 int _updatedRemotelyId; // id of the updatedRemotely() signal - makes things faster
231 QHash<int, MethodDescriptor> _methods;
232 QHash<QByteArray, int> _methodIds;
233 QHash<int, int> _receiveMap; // if slot x is called then hand over the result to slot y
237 // ==================================================
239 // ==================================================
240 class SignalProxy::AbstractPeer : public QObject
245 AbstractPeer(QObject *parent = 0) : QObject(parent) {}
247 virtual QString description() const = 0;
249 virtual void setSignalProxy(SignalProxy *proxy) = 0;
251 virtual bool isOpen() const = 0;
252 virtual bool isSecure() const = 0;
253 virtual bool isLocal() const = 0;
255 virtual QString errorString() const { return QString(); }
257 virtual int lag() const = 0;
260 virtual void dispatch(const SyncMessage &msg) = 0;
261 virtual void dispatch(const RpcCall &msg) = 0;
262 virtual void dispatch(const InitRequest &msg) = 0;
263 virtual void dispatch(const InitData &msg) = 0;
265 virtual void close(const QString &reason = QString()) = 0;
269 void error(QAbstractSocket::SocketError);
270 void secureStateChanged(bool secure = true);
271 void lagUpdated(int msecs);
275 // ==================================================
277 // ==================================================
278 class SignalProxy::SyncMessage
281 inline SyncMessage(const QByteArray &className, const QString &objectName, const QByteArray &slotName, const QVariantList ¶ms)
282 : _className(className), _objectName(objectName), _slotName(slotName), _params(params) {}
284 inline QByteArray className() const { return _className; }
285 inline QString objectName() const { return _objectName; }
286 inline QByteArray slotName() const { return _slotName; }
288 inline QVariantList params() const { return _params; }
291 QByteArray _className;
293 QByteArray _slotName;
294 QVariantList _params;
298 class SignalProxy::RpcCall
301 inline RpcCall(const QByteArray &slotName, const QVariantList ¶ms)
302 : _slotName(slotName), _params(params) {}
304 inline QByteArray slotName() const { return _slotName; }
305 inline QVariantList params() const { return _params; }
308 QByteArray _slotName;
309 QVariantList _params;
313 class SignalProxy::InitRequest
316 inline InitRequest(const QByteArray &className, const QString &objectName)
317 : _className(className), _objectName(objectName) {}
319 inline QByteArray className() const { return _className; }
320 inline QString objectName() const { return _objectName; }
323 QByteArray _className;
328 class SignalProxy::InitData
331 inline InitData(const QByteArray &className, const QString &objectName, const QVariantMap &initData)
332 : _className(className), _objectName(objectName), _initData(initData) {}
334 inline QByteArray className() const { return _className; }
335 inline QString objectName() const { return _objectName; }
337 inline QVariantMap initData() const { return _initData; }
340 QByteArray _className;
342 QVariantMap _initData;