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 ***************************************************************************/
28 #include <QVariantMap>
37 class SignalProxy : public QObject
43 class SignalProxyPeer;
62 enum ClientConnectionType {
63 SignalProxyConnection,
68 PeerSignal = QEvent::User,
72 SignalProxy(QObject *parent);
73 SignalProxy(ProxyMode mode, QObject *parent);
74 SignalProxy(ProxyMode mode, QIODevice *device, QObject *parent);
75 virtual ~SignalProxy();
77 void setProxyMode(ProxyMode mode);
78 inline ProxyMode proxyMode() const { return _proxyMode; }
80 void setHeartBeatInterval(int secs);
81 inline int heartBeatInterval() const { return _heartBeatInterval; }
82 void setMaxHeartBeatCount(int max);
83 inline int maxHeartBeatCount() const { return _maxHeartBeatCount; }
85 bool addPeer(QIODevice *iodev);
86 bool addPeer(SignalProxy *proxy);
87 void removePeer(QObject *peer);
88 void removeAllPeers();
90 bool attachSignal(QObject *sender, const char *signal, const QByteArray &sigName = QByteArray());
91 bool attachSlot(const QByteArray &sigName, QObject *recv, const char *slot);
93 void synchronize(SyncableObject *obj);
94 void stopSynchronize(SyncableObject *obj);
96 //! Writes a QVariant to a device.
97 /** The data item is prefixed with the resulting blocksize,
98 * so the corresponding function readDataFromDevice() can check if enough data is available
99 * at the device to reread the item.
101 static void writeDataToDevice(QIODevice *dev, const QVariant &item, bool compressed = false);
103 //! Reads a data item from a device that has been written by writeDataToDevice().
104 /** If not enough data bytes are available, the function returns false and the QVariant reference
107 static bool readDataFromDevice(QIODevice *dev, quint32 &blockSize, QVariant &item, bool compressed = false);
109 class ExtendedMetaObject;
110 ExtendedMetaObject *extendedMetaObject(const QMetaObject *meta) const;
111 ExtendedMetaObject *createExtendedMetaObject(const QMetaObject *meta, bool checkConflicts = false);
112 inline ExtendedMetaObject *extendedMetaObject(const QObject *obj) const { return extendedMetaObject(metaObject(obj)); }
113 inline ExtendedMetaObject *createExtendedMetaObject(const QObject *obj, bool checkConflicts = false) { return createExtendedMetaObject(metaObject(obj), checkConflicts); }
115 bool isSecure() const { return _secure; }
116 void dumpProxyStats();
119 void detachObject(QObject *obj);
120 void detachSignals(QObject *sender);
121 void detachSlots(QObject *receiver);
124 void customEvent(QEvent *event);
125 void sync_call__(const SyncableObject *obj, ProxyMode modeType, const char *funcname, va_list ap);
126 void renameObject(const SyncableObject *obj, const QString &newname, const QString &oldname);
129 void dataAvailable();
130 void removePeerBySender();
131 void objectRenamed(const QByteArray &classname, const QString &newname, const QString &oldname);
132 void sendHeartBeat();
133 void receiveHeartBeat(AbstractPeer *peer, const QVariantList ¶ms);
134 void receiveHeartBeatReply(AbstractPeer *peer, const QVariantList ¶ms);
136 void updateSecureState();
139 void peerRemoved(QIODevice *dev);
142 void objectInitialized(SyncableObject *);
143 void lagUpdated(int lag);
144 void securityChanged(bool);
145 void secureStateChanged(bool);
152 static const QMetaObject *metaObject(const QObject *obj);
154 void dispatchSignal(QIODevice *receiver, const RequestType &requestType, const QVariantList ¶ms);
155 void dispatchSignal(const RequestType &requestType, const QVariantList ¶ms);
157 void receivePackedFunc(AbstractPeer *sender, const QVariant &packedFunc);
158 void receivePeerSignal(AbstractPeer *sender, const RequestType &requestType, const QVariantList ¶ms);
159 void receivePeerSignal(SignalProxy *sender, const RequestType &requestType, const QVariantList ¶ms);
160 void handleSync(AbstractPeer *sender, QVariantList params);
161 void handleInitRequest(AbstractPeer *sender, const QVariantList ¶ms);
162 void handleInitData(AbstractPeer *sender, const QVariantList ¶ms);
163 void handleSignal(const QVariantList &data);
165 bool invokeSlot(QObject *receiver, int methodId, const QVariantList ¶ms, QVariant &returnValue);
166 bool invokeSlot(QObject *receiver, int methodId, const QVariantList ¶ms = QVariantList());
168 void requestInit(SyncableObject *obj);
169 QVariantMap initData(SyncableObject *obj) const;
170 void setInitData(SyncableObject *obj, const QVariantMap &properties);
172 void updateLag(IODevicePeer *peer, int lag);
175 void dumpSyncMap(SyncableObject *object);
176 inline int peerCount() const { return _peers.size(); }
179 static void disconnectDevice(QIODevice *dev, const QString &reason = QString());
181 // a Hash of the actual used communication object to it's corresponding peer
182 // currently a communication object can either be an arbitrary QIODevice or another SignalProxy
183 typedef QHash<QObject *, AbstractPeer *> PeerHash;
186 // containg a list of argtypes for fast access
187 QHash<const QMetaObject *, ExtendedMetaObject *> _extendedMetaObjects;
189 // SignalRelay for all manually attached signals
190 SignalRelay *_signalRelay;
192 // RPC function -> (object, slot ID)
193 typedef QPair<QObject *, int> MethodId;
194 typedef QMultiHash<QByteArray, MethodId> SlotHash;
195 SlotHash _attachedSlots;
198 typedef QHash<QString, SyncableObject *> ObjectId;
199 QHash<QByteArray, ObjectId> _syncSlave;
201 ProxyMode _proxyMode;
202 QTimer _heartBeatTimer;
203 int _heartBeatInterval;
204 int _maxHeartBeatCount;
206 bool _secure; // determines if all connections are in a secured state (using ssl or internal connections)
208 friend class SignalRelay;
209 friend class SyncableObject;
213 // ==================================================
214 // ExtendedMetaObject
215 // ==================================================
216 class SignalProxy::ExtendedMetaObject
218 class MethodDescriptor
221 MethodDescriptor(const QMetaMethod &method);
222 MethodDescriptor() : _returnType(-1), _minArgCount(-1), _receiverMode(SignalProxy::Client) {}
224 inline const QByteArray &methodName() const { return _methodName; }
225 inline const QList<int> &argTypes() const { return _argTypes; }
226 inline int returnType() const { return _returnType; }
227 inline int minArgCount() const { return _minArgCount; }
228 inline SignalProxy::ProxyMode receiverMode() const { return _receiverMode; }
231 QByteArray _methodName;
232 QList<int> _argTypes;
235 SignalProxy::ProxyMode _receiverMode; // Only acceptable as a Sync Call if the receiving SignalProxy is in this mode.
240 ExtendedMetaObject(const QMetaObject *meta, bool checkConflicts);
242 inline const QByteArray &methodName(int methodId) { return methodDescriptor(methodId).methodName(); }
243 inline const QList<int> &argTypes(int methodId) { return methodDescriptor(methodId).argTypes(); }
244 inline int returnType(int methodId) { return methodDescriptor(methodId).returnType(); }
245 inline int minArgCount(int methodId) { return methodDescriptor(methodId).minArgCount(); }
246 inline SignalProxy::ProxyMode receiverMode(int methodId) { return methodDescriptor(methodId).receiverMode(); }
248 inline int methodId(const QByteArray &methodName) { return _methodIds.contains(methodName) ? _methodIds[methodName] : -1; }
250 inline int updatedRemotelyId() { return _updatedRemotelyId; }
252 inline const QHash<QByteArray, int> &slotMap() { return _methodIds; }
253 const QHash<int, int> &receiveMap();
255 const QMetaObject *metaObject() const { return _meta; }
257 static QByteArray methodName(const QMetaMethod &method);
258 static QString methodBaseName(const QMetaMethod &method);
261 const MethodDescriptor &methodDescriptor(int methodId);
263 const QMetaObject *_meta;
264 int _updatedRemotelyId; // id of the updatedRemotely() signal - makes things faster
266 QHash<int, MethodDescriptor> _methods;
267 QHash<QByteArray, int> _methodIds;
268 QHash<int, int> _receiveMap; // if slot x is called then hand over the result to slot y
272 // ==================================================
274 // ==================================================
275 class SignalProxy::AbstractPeer
283 AbstractPeer() : _type(NotAPeer) {}
284 AbstractPeer(PeerType type) : _type(type) {}
285 virtual ~AbstractPeer() {}
286 inline PeerType type() const { return _type; }
287 virtual void dispatchSignal(const RequestType &requestType, const QVariantList ¶ms) = 0;
288 virtual bool isSecure() const = 0;
294 class SignalProxy::IODevicePeer : public SignalProxy::AbstractPeer
297 IODevicePeer(QIODevice *device, bool compress) : AbstractPeer(AbstractPeer::IODevicePeer), _device(device), byteCount(0), usesCompression(compress), sentHeartBeats(0), lag(0) {}
298 virtual void dispatchSignal(const RequestType &requestType, const QVariantList ¶ms);
299 virtual bool isSecure() const;
300 inline void dispatchPackedFunc(const QVariant &packedFunc) { SignalProxy::writeDataToDevice(_device, packedFunc, usesCompression); }
301 QString address() const;
302 inline bool isOpen() const { return _device->isOpen(); }
303 inline void close() const { _device->close(); }
304 inline bool readData(QVariant &item) { return SignalProxy::readDataFromDevice(_device, byteCount, item, usesCompression); }
308 bool usesCompression;
315 class SignalProxy::SignalProxyPeer : public SignalProxy::AbstractPeer
318 SignalProxyPeer(SignalProxy *sender, SignalProxy *receiver) : AbstractPeer(AbstractPeer::SignalProxyPeer), sender(sender), receiver(receiver) {}
319 virtual void dispatchSignal(const RequestType &requestType, const QVariantList ¶ms);
320 virtual inline bool isSecure() const { return true; }
323 SignalProxy *receiver;