X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Fsignalproxy.h;h=9bae6364685f8265da8876c3abcb1f62d59c322b;hp=1090547e3fbf6909d0f55bc6e8ea8955c1c89f89;hb=f6b9eeda207d42c99fc3e9085631722cf2ec83dc;hpb=a14eac175cceda16f50cb4519182f819cf7f6b23 diff --git a/src/common/signalproxy.h b/src/common/signalproxy.h index 1090547e..9bae6364 100644 --- a/src/common/signalproxy.h +++ b/src/common/signalproxy.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-08 by the Quassel Project * + * Copyright (C) 2005-09 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -18,9 +18,10 @@ * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * ***************************************************************************/ -#ifndef _SIGNALPROXY_H_ -#define _SIGNALPROXY_H_ +#ifndef SIGNALPROXY_H +#define SIGNALPROXY_H +#include #include #include #include @@ -30,13 +31,18 @@ #include #include -class SignalRelay; class SyncableObject; struct QMetaObject; class SignalProxy : public QObject { Q_OBJECT + class AbstractPeer; + class IODevicePeer; + class SignalProxyPeer; + + class SignalRelay; + public: enum ProxyMode { Server, @@ -48,7 +54,18 @@ public: RpcCall, InitRequest, InitData, - HeartBeat + HeartBeat, + HeartBeatReply + }; + + enum ClientConnectionType { + SignalProxyConnection, + IODeviceConnection + }; + + enum CustomEvents { + PeerSignal = QEvent::User, + RemovePeer }; SignalProxy(QObject *parent); @@ -57,119 +74,114 @@ 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(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); + 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); - - 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(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; - int updatedRemotelyId; // id of the updatedRemotely() signal - makes things faster - QHash syncMap; - QHash receiveMap; - }; + static bool readDataFromDevice(QIODevice *dev, quint32 &blockSize, QVariant &item, bool compressed = false); + class ExtendedMetaObject; + ExtendedMetaObject *extendedMetaObject(const QMetaObject *meta) const; + ExtendedMetaObject *createExtendedMetaObject(const QMetaObject *meta); + inline ExtendedMetaObject *extendedMetaObject(const QObject *obj) const { return extendedMetaObject(metaObject(obj)); } + inline ExtendedMetaObject *createExtendedMetaObject(const QObject *obj) { return createExtendedMetaObject(metaObject(obj)); } + + bool isSecure() const { return _secure; } void dumpProxyStats(); - + +public slots: + void detachObject(QObject *obj); + void detachSignals(QObject *sender); + void detachSlots(QObject *receiver); + void stopSync(QObject *obj); + +protected: + void customEvent(QEvent *event); + void sync_call__(const SyncableObject *obj, ProxyMode modeType, const char *funcname, va_list ap); + 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 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; + + static const QMetaObject *metaObject(const QObject *obj); 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); + + 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()); + void requestInit(SyncableObject *obj); 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: - // Hash of used QIODevices - QHash _peerByteCount; + static void disconnectDevice(QIODevice *dev, const QString &reason = QString()); + + // 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; + QHash _extendedMetaObjects; - // we use one SignalRelay per QObject - QHash _relayHash; + // SignalRelay for all manually attached signals + SignalRelay *_signalRelay; // RPC function -> (object, slot ID) typedef QPair MethodId; @@ -183,8 +195,117 @@ private: ProxyMode _proxyMode; QTimer _heartBeatTimer; - + + bool _secure; // determines if all connections are in a secured state (using ssl or internal connections) + friend class SignalRelay; + friend class SyncableObject; +}; + + +// ================================================== +// 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 &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 _argTypes; + int _returnType; + int _minArgCount; + SignalProxy::ProxyMode _receiverMode; // Only acceptable as a Sync Call if the receiving SignalProxy is in this mode. + }; + +public: + ExtendedMetaObject(const QMetaObject *meta); + + inline const QByteArray &methodName(int methodId) { return methodDescriptor(methodId).methodName(); } + inline const QList &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; } + + inline int updatedRemotelyId() { return _updatedRemotelyId; } + + inline const QHash &slotMap() { return _methodIds; } + const QHash &receiveMap(); + + const QMetaObject *metaObject() const { return _meta; } + + static QByteArray methodName(const QMetaMethod &method); + static QString ExtendedMetaObject::methodBaseName(const QMetaMethod &method); + +private: + const MethodDescriptor &methodDescriptor(int methodId); + + const QMetaObject *_meta; + int _updatedRemotelyId; // id of the updatedRemotely() signal - makes things faster + + QHash _methods; + QHash _methodIds; + QHash _receiveMap; // if slot x is called then hand over the result to slot y +}; + + +// ================================================== +// Peers +// ================================================== +class SignalProxy::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 SignalProxy::IODevicePeer : public SignalProxy::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 SignalProxy::SignalProxyPeer : public SignalProxy::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; }; #endif