X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Fsignalproxy.h;h=755461e92795b036dd32b6d483e0005e767b6de2;hp=50010607604019fcd214890ee75dc5a6f33de128;hb=aa7841638c6537034102da959cad8c36853bf280;hpb=a7f5d6a23f7214b11f6db85346a67fd7d02767da diff --git a/src/common/signalproxy.h b/src/common/signalproxy.h index 50010607..755461e9 100644 --- a/src/common/signalproxy.h +++ b/src/common/signalproxy.h @@ -1,11 +1,11 @@ /*************************************************************************** - * 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 * @@ -16,21 +16,12 @@ * 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 . 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 #include #include #include @@ -38,13 +29,18 @@ #include #include #include +#include class SignalRelay; -class QMetaObject; +class SyncableObject; +struct QMetaObject; class SignalProxy : public QObject { Q_OBJECT + class AbstractPeer; + class IODevicePeer; + public: enum ProxyMode { Server, @@ -52,9 +48,22 @@ public: }; enum RequestType { - Sync = 0, + Sync = 1, + RpcCall, InitRequest, - InitData + InitData, + HeartBeat, + HeartBeatReply + }; + + enum ClientConnectionType { + SignalProxyConnection, + IODeviceConnection + }; + + enum CustomEvents { + PeerSignal = QEvent::User, + RemovePeer }; SignalProxy(QObject *parent); @@ -63,85 +72,174 @@ public: virtual ~SignalProxy(); void setProxyMode(ProxyMode mode); - ProxyMode proxyMode() const; + inline ProxyMode proxyMode() const { return _proxyMode; } 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(QObject *obj); - void synchronizeAsMaster(QObject *obj); - void synchronizeAsSlave(QObject *obj); + void synchronize(SyncableObject *obj); + +// void setInitialized(SyncableObject *obj); +// bool isInitialized(SyncableObject *obj) const; + void requestInit(SyncableObject *obj); - void setInitialized(QObject *obj); - bool initialized(QObject *obj); - void requestInit(QObject *obj); - void detachObject(QObject *obj); void detachSignals(QObject *sender); void detachSlots(QObject *receiver); - - static void writeDataToDevice(QIODevice *dev, const QVariant &item); - static bool readDataFromDevice(QIODevice *dev, quint32 &blockSize, QVariant &item); + 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, 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); static QString methodBaseName(const QMetaMethod &method); - + const QList &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 &syncMap(QObject *obj); + const QHash &syncMap(SyncableObject *obj); + const QHash &receiveMap(SyncableObject *obj); + int updatedRemotelyId(SyncableObject *obj); typedef QHash > ArgHash; typedef QHash MethodNameHash; struct ClassInfo { ArgHash argTypes; + QHash returnType; + QHash minArgCount; MethodNameHash methodNames; - QHash syncMap; + int updatedRemotelyId; // id of the updatedRemotely() signal - makes things faster + QHash syncMap; + QHash receiveMap; }; void dumpProxyStats(); +protected: + void customEvent(QEvent *event); + private slots: void dataAvailable(); void detachSender(); void removePeerBySender(); - void objectRenamed(QString oldname, QString newname); - void objectRenamed(QByteArray classname, QString oldname, QString newname); - + 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); + signals: - void peerRemoved(QIODevice *obj); + void peerRemoved(QIODevice *dev); void connected(); void disconnected(); + void objectInitialized(SyncableObject *); + void lagUpdated(int lag); private: + void init(); 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(QObject *obj); + 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 QVariant &identifier, const QVariantList ¶ms); - void dispatchSignal(const QVariant &identifier, const QVariantList ¶ms); + 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(); } - void receivePeerSignal(QIODevice *sender, const QVariant &packedFunc); - void handleSync(QVariantList params); - void handleInitRequest(QIODevice *sender, const QVariantList ¶ms); - void handleInitData(QIODevice *sender, const QVariantList ¶ms); - void handleSignal(const QByteArray &funcName, const QVariantList ¶ms); +private: + static void disconnectDevice(QIODevice *dev, const QString &reason = QString()); - bool invokeSlot(QObject *receiver, int methodId, const QVariantList ¶ms); + 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; + private: + PeerType _type; + }; - QVariantMap initData(QObject *obj) const; - void setInitData(QObject *obj, const QVariantMap &properties); - bool setInitValue(QObject *obj, const QString &property, const QVariant &value); + 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); + 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; + }; - void _detachSignals(QObject *sender); - void _detachSlots(QObject *receiver); + 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); + 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 PeerHash; + PeerHash _peers; // containg a list of argtypes for fast access QHash _classInfo; @@ -155,14 +253,13 @@ private: SlotHash _attachedSlots; // slaves for sync - typedef QHash ObjectId; + typedef QHash ObjectId; QHash _syncSlave; - // Hash of used QIODevices - QHash _peerByteCount; ProxyMode _proxyMode; - + QTimer _heartBeatTimer; + friend class SignalRelay; };