/***************************************************************************
- * Copyright (C) 2005-08 by the Quassel Project *
+ * Copyright (C) 2005-2014 by the Quassel Project *
* devel@quassel-irc.org *
* *
* This program is free software; you can redistribute it and/or modify *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
***************************************************************************/
-#ifndef _SIGNALPROXY_H_
-#define _SIGNALPROXY_H_
+#ifndef SIGNALPROXY_H
+#define SIGNALPROXY_H
-#include <QList>
-#include <QHash>
-#include <QVariant>
-#include <QVariantMap>
-#include <QPair>
-#include <QString>
-#include <QByteArray>
-#include <QTimer>
+#include <QEvent>
+#include <QSet>
-class SignalRelay;
+#include "protocol.h"
+
+struct QMetaObject;
+
+class Peer;
class SyncableObject;
-class QMetaObject;
-class SignalProxy : public QObject {
- Q_OBJECT
+class SignalProxy : public QObject
+{
+ Q_OBJECT
+
+ class SignalRelay;
public:
- enum ProxyMode {
- Server,
- Client
- };
-
- enum RequestType {
- Sync = 1,
- RpcCall,
- InitRequest,
- InitData,
- HeartBeat
- };
-
- SignalProxy(QObject *parent);
- SignalProxy(ProxyMode mode, QObject *parent);
- SignalProxy(ProxyMode mode, QIODevice *device, QObject *parent);
- virtual ~SignalProxy();
-
- void setProxyMode(ProxyMode mode);
- ProxyMode proxyMode() const;
-
- bool addPeer(QIODevice *iodev);
- void removePeer(QIODevice *iodev = 0);
-
- bool attachSignal(QObject *sender, const char *signal, const QByteArray& sigName = QByteArray());
- bool attachSlot(const QByteArray& sigName, QObject *recv, const char *slot);
-
- void synchronize(SyncableObject *obj);
-
- void setInitialized(SyncableObject *obj);
- bool isInitialized(SyncableObject *obj) const;
- void requestInit(SyncableObject *obj);
-
- void detachObject(QObject *obj);
- void detachSignals(QObject *sender);
- void detachSlots(QObject *receiver);
- void stopSync(SyncableObject *obj);
-
- //! Writes a QVariant to a device.
- /** The data item is prefixed with the resulting blocksize,
- * so the corresponding function readDataFromDevice() can check if enough data is available
- * at the device to reread the item.
- */
- static void writeDataToDevice(QIODevice *dev, const QVariant &item);
-
- //! Reads a data item from a device that has been written by writeDataToDevice().
- /** If not enough data bytes are available, the function returns false and the QVariant reference
- * remains untouched.
- */
- static bool readDataFromDevice(QIODevice *dev, quint32 &blockSize, QVariant &item);
-
- static QString methodBaseName(const QMetaMethod &method);
-
- const QList<int> &argTypes(QObject *obj, int methodId);
- const int &returnType(QObject *obj, int methodId);
- const int &minArgCount(QObject *obj, int methodId);
- const QByteArray &methodName(QObject *obj, int methodId);
- const QHash<QByteArray, int> &syncMap(SyncableObject *obj);
- const QHash<int, int> &receiveMap(SyncableObject *obj);
- int updatedRemotelyId(SyncableObject *obj);
-
- typedef QHash<int, QList<int> > ArgHash;
- typedef QHash<int, QByteArray> MethodNameHash;
- struct ClassInfo {
- ArgHash argTypes;
- QHash<int, int> returnType;
- QHash<int, int> minArgCount;
- MethodNameHash methodNames;
- int updatedRemotelyId; // id of the updatedRemotely() signal - makes things faster
- QHash<QByteArray, int> syncMap;
- QHash<int, int> receiveMap;
- };
-
- void dumpProxyStats();
-
+ enum ProxyMode {
+ Server,
+ Client
+ };
+
+ enum EventType {
+ RemovePeerEvent = QEvent::User
+ };
+
+ SignalProxy(QObject *parent);
+ SignalProxy(ProxyMode mode, QObject *parent);
+ virtual ~SignalProxy();
+
+ void setProxyMode(ProxyMode mode);
+ inline ProxyMode proxyMode() const { return _proxyMode; }
+
+ void setHeartBeatInterval(int secs);
+ inline int heartBeatInterval() const { return _heartBeatInterval; }
+ void setMaxHeartBeatCount(int max);
+ inline int maxHeartBeatCount() const { return _maxHeartBeatCount; }
+
+ bool addPeer(Peer *peer);
+
+ bool attachSignal(QObject *sender, const char *signal, const QByteArray &sigName = QByteArray());
+ bool attachSlot(const QByteArray &sigName, QObject *recv, const char *slot);
+
+ void synchronize(SyncableObject *obj);
+ void stopSynchronize(SyncableObject *obj);
+
+ class ExtendedMetaObject;
+ ExtendedMetaObject *extendedMetaObject(const QMetaObject *meta) const;
+ ExtendedMetaObject *createExtendedMetaObject(const QMetaObject *meta, bool checkConflicts = false);
+ inline ExtendedMetaObject *extendedMetaObject(const QObject *obj) const { return extendedMetaObject(metaObject(obj)); }
+ inline ExtendedMetaObject *createExtendedMetaObject(const QObject *obj, bool checkConflicts = false) { return createExtendedMetaObject(metaObject(obj), checkConflicts); }
+
+ bool isSecure() const { return _secure; }
+ void dumpProxyStats();
+ void dumpSyncMap(SyncableObject *object);
+ inline int peerCount() const { return _peers.size(); }
+
+public slots:
+ void detachObject(QObject *obj);
+ void detachSignals(QObject *sender);
+ void detachSlots(QObject *receiver);
+
+protected:
+ void customEvent(QEvent *event);
+ void sync_call__(const SyncableObject *obj, ProxyMode modeType, const char *funcname, va_list ap);
+ void renameObject(const SyncableObject *obj, const QString &newname, const QString &oldname);
+
private slots:
- void dataAvailable();
- void detachSender();
- void removePeerBySender();
- void objectRenamed(const QString &newname, const QString &oldname);
- void objectRenamed(const QByteArray &classname, const QString &newname, const QString &oldname);
- void sendHeartBeat();
+ void removePeerBySender();
+ void objectRenamed(const QByteArray &classname, const QString &newname, const QString &oldname);
+ void updateSecureState();
signals:
- void peerRemoved(QIODevice *obj);
- void connected();
- void disconnected();
- void objectInitialized(SyncableObject *);
-
+ void peerRemoved(Peer *peer);
+ void connected();
+ void disconnected();
+ void objectInitialized(SyncableObject *);
+ void heartBeatIntervalChanged(int secs);
+ void maxHeartBeatCountChanged(int max);
+ void lagUpdated(int lag);
+ void secureStateChanged(bool);
+
private:
- void initServer();
- void initClient();
-
- const QMetaObject *metaObject(QObject *obj);
- void createClassInfo(QObject *obj);
- void setArgTypes(QObject *obj, int methodId);
- void setReturnType(QObject *obj, int methodId);
- void setMinArgCount(QObject *obj, int methodId);
- void setMethodName(QObject *obj, int methodId);
- void setSyncMap(SyncableObject *obj);
- void setReceiveMap(SyncableObject *obj);
- void setUpdatedRemotelyId(SyncableObject *obj);
-
- bool methodsMatch(const QMetaMethod &signal, const QMetaMethod &slot) const;
-
- void dispatchSignal(QIODevice *receiver, const RequestType &requestType, const QVariantList ¶ms);
- void dispatchSignal(const RequestType &requestType, const QVariantList ¶ms);
-
- void receivePeerSignal(QIODevice *sender, const QVariant &packedFunc);
- void handleSync(QIODevice *sender, QVariantList params);
- void handleInitRequest(QIODevice *sender, const QVariantList ¶ms);
- void handleInitData(QIODevice *sender, const QVariantList ¶ms);
- void handleSignal(const QByteArray &funcName, const QVariantList ¶ms);
-
- bool invokeSlot(QObject *receiver, int methodId, const QVariantList ¶ms, QVariant &returnValue);
- bool invokeSlot(QObject *receiver, int methodId, const QVariantList ¶ms = QVariantList());
-
- QVariantMap initData(SyncableObject *obj) const;
- void setInitData(SyncableObject *obj, const QVariantMap &properties);
+ template<class T>
+ class PeerMessageEvent;
+
+ void init();
+ void initServer();
+ void initClient();
+
+ static const QMetaObject *metaObject(const QObject *obj);
+
+ void removePeer(Peer *peer);
+ void removeAllPeers();
+
+ template<class T>
+ void dispatch(const T &protoMessage);
+ template<class T>
+ void dispatch(Peer *peer, const T &protoMessage);
+
+ void handle(Peer *peer, const Protocol::SyncMessage &syncMessage);
+ void handle(Peer *peer, const Protocol::RpcCall &rpcCall);
+ void handle(Peer *peer, const Protocol::InitRequest &initRequest);
+ void handle(Peer *peer, const Protocol::InitData &initData);
+
+ template<class T>
+ void handle(Peer *, T) { Q_ASSERT(0); }
+
+ bool invokeSlot(QObject *receiver, int methodId, const QVariantList ¶ms, QVariant &returnValue, Peer *peer = 0);
+ bool invokeSlot(QObject *receiver, int methodId, const QVariantList ¶ms = QVariantList(), Peer *peer = 0);
+
+ void requestInit(SyncableObject *obj);
+ QVariantMap initData(SyncableObject *obj) const;
+ void setInitData(SyncableObject *obj, const QVariantMap &properties);
+
+ static void disconnectDevice(QIODevice *dev, const QString &reason = QString());
+
+ QSet<Peer *> _peers;
+
+ // containg a list of argtypes for fast access
+ QHash<const QMetaObject *, ExtendedMetaObject *> _extendedMetaObjects;
+
+ // SignalRelay for all manually attached signals
+ SignalRelay *_signalRelay;
+
+ // RPC function -> (object, slot ID)
+ typedef QPair<QObject *, int> MethodId;
+ typedef QMultiHash<QByteArray, MethodId> SlotHash;
+ SlotHash _attachedSlots;
+
+ // slaves for sync
+ typedef QHash<QString, SyncableObject *> ObjectId;
+ QHash<QByteArray, ObjectId> _syncSlave;
+
+ ProxyMode _proxyMode;
+ int _heartBeatInterval;
+ int _maxHeartBeatCount;
+
+ bool _secure; // determines if all connections are in a secured state (using ssl or internal connections)
+
+ friend class SignalRelay;
+ friend class SyncableObject;
+ friend class Peer;
+};
+
+
+// ==================================================
+// ExtendedMetaObject
+// ==================================================
+class SignalProxy::ExtendedMetaObject
+{
+ class MethodDescriptor
+ {
+ public:
+ MethodDescriptor(const QMetaMethod &method);
+ MethodDescriptor() : _returnType(-1), _minArgCount(-1), _receiverMode(SignalProxy::Client) {}
+
+ inline const QByteArray &methodName() const { return _methodName; }
+ inline const QList<int> &argTypes() const { return _argTypes; }
+ inline int returnType() const { return _returnType; }
+ inline int minArgCount() const { return _minArgCount; }
+ inline SignalProxy::ProxyMode receiverMode() const { return _receiverMode; }
+
+ private:
+ QByteArray _methodName;
+ QList<int> _argTypes;
+ int _returnType;
+ int _minArgCount;
+ SignalProxy::ProxyMode _receiverMode; // Only acceptable as a Sync Call if the receiving SignalProxy is in this mode.
+ };
+
public:
- void dumpSyncMap(SyncableObject *object);
-
-private:
- // Hash of used QIODevices
- QHash<QIODevice*, quint32> _peerByteCount;
+ ExtendedMetaObject(const QMetaObject *meta, bool checkConflicts);
+
+ inline const QByteArray &methodName(int methodId) { return methodDescriptor(methodId).methodName(); }
+ inline const QList<int> &argTypes(int methodId) { return methodDescriptor(methodId).argTypes(); }
+ inline int returnType(int methodId) { return methodDescriptor(methodId).returnType(); }
+ inline int minArgCount(int methodId) { return methodDescriptor(methodId).minArgCount(); }
+ inline SignalProxy::ProxyMode receiverMode(int methodId) { return methodDescriptor(methodId).receiverMode(); }
+
+ inline int methodId(const QByteArray &methodName) { return _methodIds.contains(methodName) ? _methodIds[methodName] : -1; }
- // containg a list of argtypes for fast access
- QHash<const QMetaObject *, ClassInfo*> _classInfo;
+ inline int updatedRemotelyId() { return _updatedRemotelyId; }
- // we use one SignalRelay per QObject
- QHash<QObject*, SignalRelay *> _relayHash;
+ inline const QHash<QByteArray, int> &slotMap() { return _methodIds; }
+ const QHash<int, int> &receiveMap();
- // RPC function -> (object, slot ID)
- typedef QPair<QObject*, int> MethodId;
- typedef QMultiHash<QByteArray, MethodId> SlotHash;
- SlotHash _attachedSlots;
+ const QMetaObject *metaObject() const { return _meta; }
- // slaves for sync
- typedef QHash<QString, SyncableObject *> ObjectId;
- QHash<QByteArray, ObjectId> _syncSlave;
+ static QByteArray methodName(const QMetaMethod &method);
+ static QString methodBaseName(const QMetaMethod &method);
+
+private:
+ const MethodDescriptor &methodDescriptor(int methodId);
+ const QMetaObject *_meta;
+ int _updatedRemotelyId; // id of the updatedRemotely() signal - makes things faster
- ProxyMode _proxyMode;
- QTimer _heartBeatTimer;
-
- friend class SignalRelay;
+ QHash<int, MethodDescriptor> _methods;
+ QHash<QByteArray, int> _methodIds;
+ QHash<int, int> _receiveMap; // if slot x is called then hand over the result to slot y
};
#endif