/***************************************************************************
- * Copyright (C) 2005-07 by the Quassel IRC Team *
+ * Copyright (C) 2005-08 by the Quassel Project *
* devel@quassel-irc.org *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
- * (at your option) any later version. *
+ * (at your option) version 3. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
- ***************************************************************************
- * SignalProxy has been inspired by QxtRPCPeer, part of libqxt, *
- * the Qt eXTension Library <http://www.libqxt.org>. We would like to *
- * thank Arvid "aep" Picciani and Adam "ahigerd" Higerd for providing *
- * QxtRPCPeer, valuable input and the genius idea to (ab)use Qt's *
- * Meta Object System for transmitting signals over the network. *
- * *
- * To make contribution back into libqxt possible, redistribution and *
- * modification of this file is additionally allowed under the terms of *
- * the Common Public License, version 1.0, as published by IBM. *
***************************************************************************/
-#ifndef _SIGNALPROXY_H_
-#define _SIGNALPROXY_H_
+#ifndef SIGNALPROXY_H
+#define SIGNALPROXY_H
+#include <QEvent>
#include <QList>
#include <QHash>
#include <QVariant>
+#include <QVariantMap>
#include <QPair>
#include <QString>
#include <QByteArray>
+#include <QTimer>
class SignalRelay;
+class SyncableObject;
+struct QMetaObject;
class SignalProxy : public QObject {
Q_OBJECT
+ class AbstractPeer;
+ class IODevicePeer;
+
public:
enum ProxyMode {
Server,
Client
};
- SignalProxy(QObject* parent);
- SignalProxy(ProxyMode mode, QObject* parent);
- SignalProxy(ProxyMode mode, QIODevice* device, QObject* parent);
+ enum RequestType {
+ Sync = 1,
+ RpcCall,
+ InitRequest,
+ InitData,
+ HeartBeat,
+ HeartBeatReply
+ };
+
+ enum ClientConnectionType {
+ SignalProxyConnection,
+ IODeviceConnection
+ };
+
+ enum CustomEvents {
+ PeerSignal = QEvent::User,
+ RemovePeer
+ };
+
+ SignalProxy(QObject *parent);
+ SignalProxy(ProxyMode mode, QObject *parent);
+ SignalProxy(ProxyMode mode, QIODevice *device, QObject *parent);
virtual ~SignalProxy();
void setProxyMode(ProxyMode mode);
- ProxyMode proxyMode() const;
+ inline ProxyMode proxyMode() const { return _proxyMode; }
- bool maxPeersReached();
-
bool addPeer(QIODevice *iodev);
- void removePeer(QIODevice *iodev = 0);
+ bool addPeer(SignalProxy *proxy);
+ void removePeer(QObject *peer);
+ void removeAllPeers();
+
+ 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);
- bool attachSignal(QObject* sender, const char* signal, const QByteArray& sigName = QByteArray());
- bool attachSlot(const QByteArray& sigName, QObject* recv, const char* slot);
+// 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 call(const char *signal , QVariant p1, QVariant p2, QVariant p3, QVariant p4,
- QVariant p5, QVariant p6, QVariant p7, QVariant p8, QVariant p9);
- void call(const QByteArray &funcName, const QVariantList ¶ms);
+ void stopSync(SyncableObject *obj);
- static void writeDataToDevice(QIODevice *dev, const QVariant &item);
- static bool readDataFromDevice(QIODevice *dev, quint32 &blockSize, QVariant &item);
-
- const QList<int> &argTypes(QObject* obj, int methodId);
- const QByteArray &methodName(QObject* obj, int methodId);
+ //! 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, bool compressed = false);
+
+ //! 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, bool compressed = false);
+
+ bool isSecure() const { return _secure; }
+ 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;
- // QHash<int, int> syncMap
+ int updatedRemotelyId; // id of the updatedRemotely() signal - makes things faster
+ QHash<QByteArray, int> syncMap;
+ QHash<int, int> receiveMap;
};
+
+ void dumpProxyStats();
+protected:
+ void customEvent(QEvent *event);
+
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 receiveHeartBeat(AbstractPeer *peer, const QVariantList ¶ms);
+ void receiveHeartBeatReply(AbstractPeer *peer, const QVariantList ¶ms);
+
+ void updateSecureState();
signals:
- void peerRemoved(QIODevice* obj);
+ void peerRemoved(QIODevice *dev);
void connected();
void disconnected();
-
+ void objectInitialized(SyncableObject *);
+ void lagUpdated(int lag);
+ void securityChanged(bool);
+ void secureStateChanged(bool);
+
private:
+ void init();
+ void initServer();
+ void initClient();
+
+ const QMetaObject *metaObject(QObject *obj);
void createClassInfo(QObject *obj);
- void setArgTypes(QObject* obj, int methodId);
- void setMethodName(QObject* obj, int methodId);
+ 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);
- void receivePeerSignal(const QVariant &packedFunc);
+ bool methodsMatch(const QMetaMethod &signal, const QMetaMethod &slot) const;
- void _detachSignals(QObject *sender);
- void _detachSlots(QObject *receiver);
+ void dispatchSignal(QIODevice *receiver, const RequestType &requestType, const QVariantList ¶ms);
+ void dispatchSignal(const RequestType &requestType, const QVariantList ¶ms);
+
+ void receivePackedFunc(AbstractPeer *sender, const QVariant &packedFunc);
+ void receivePeerSignal(AbstractPeer *sender, const RequestType &requestType, const QVariantList ¶ms);
+ void receivePeerSignal(SignalProxy *sender, const RequestType &requestType, const QVariantList ¶ms);
+ void handleSync(AbstractPeer *sender, QVariantList params);
+ void handleInitRequest(AbstractPeer *sender, const QVariantList ¶ms);
+ void handleInitData(AbstractPeer *sender, const QVariantList ¶ms);
+ void handleSignal(const QVariantList &data);
+
+ 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);
+
+ void updateLag(IODevicePeer *peer, int lag);
+
+public:
+ void dumpSyncMap(SyncableObject *object);
+ inline int peerCount() const { return _peers.size(); }
+
+private:
+ static void disconnectDevice(QIODevice *dev, const QString &reason = QString());
+
+ class AbstractPeer {
+ public:
+ enum PeerType {
+ NotAPeer = 0,
+ IODevicePeer = 1,
+ SignalProxyPeer = 2
+ };
+ AbstractPeer() : _type(NotAPeer) {}
+ AbstractPeer(PeerType type) : _type(type) {}
+ virtual ~AbstractPeer() {}
+ inline PeerType type() const { return _type; }
+ virtual void dispatchSignal(const RequestType &requestType, const QVariantList ¶ms) = 0;
+ virtual bool isSecure() const = 0;
+ private:
+ PeerType _type;
+ };
+
+ class IODevicePeer : public AbstractPeer {
+ public:
+ IODevicePeer(QIODevice *device, bool compress) : AbstractPeer(AbstractPeer::IODevicePeer), _device(device), byteCount(0), usesCompression(compress), sentHeartBeats(0), lag(0) {}
+ virtual void dispatchSignal(const RequestType &requestType, const QVariantList ¶ms);
+ virtual bool isSecure() const;
+ inline void dispatchPackedFunc(const QVariant &packedFunc) { SignalProxy::writeDataToDevice(_device, packedFunc, usesCompression); }
+ QString address() const;
+ inline bool isOpen() const { return _device->isOpen(); }
+ inline void close() const { _device->close(); }
+ inline bool readData(QVariant &item) { return SignalProxy::readDataFromDevice(_device, byteCount, item, usesCompression); }
+ private:
+ QIODevice *_device;
+ quint32 byteCount;
+ bool usesCompression;
+ public:
+ int sentHeartBeats;
+ int lag;
+ };
+
+ class SignalProxyPeer : public AbstractPeer {
+ public:
+ SignalProxyPeer(SignalProxy *sender, SignalProxy *receiver) : AbstractPeer(AbstractPeer::SignalProxyPeer), sender(sender), receiver(receiver) {}
+ virtual void dispatchSignal(const RequestType &requestType, const QVariantList ¶ms);
+ virtual inline bool isSecure() const { return true; }
+ private:
+ SignalProxy *sender;
+ SignalProxy *receiver;
+ };
+
+ // a Hash of the actual used communication object to it's corresponding peer
+ // currently a communication object can either be an arbitrary QIODevice or another SignalProxy
+ typedef QHash<QObject *, AbstractPeer *> PeerHash;
+ PeerHash _peers;
// containg a list of argtypes for fast access
- QHash<QByteArray, ClassInfo*> _classInfo;
+ QHash<const QMetaObject *, ClassInfo*> _classInfo;
// we use one SignalRelay per QObject
QHash<QObject*, SignalRelay *> _relayHash;
typedef QPair<QObject*, int> MethodId;
typedef QMultiHash<QByteArray, MethodId> SlotHash;
SlotHash _attachedSlots;
-
- // Hash of used QIODevices
- QHash<QIODevice*, quint32> _peerByteCount;
-
- ProxyMode _proxyMode;
- int _maxClients;
-};
+ // slaves for sync
+ typedef QHash<QString, SyncableObject *> ObjectId;
+ QHash<QByteArray, ObjectId> _syncSlave;
+ ProxyMode _proxyMode;
+ QTimer _heartBeatTimer;
+ bool _secure; // determines if all connections are in a secured state (using ssl or internal connections)
+
+ friend class SignalRelay;
+};
#endif
projects / quassel.git / blobdiff