X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Fsignalproxy.h;h=7f2a1ddc8bece917b9f5acffe1efc9a994b80239;hp=1e013f7c0e08e8ab080f412a3d461f1227a57cbf;hb=2a00e8f57d66d9913a10c30408b89676a74010a1;hpb=b30780406eabbcfdc313721e961ef063ab06c8d4 diff --git a/src/common/signalproxy.h b/src/common/signalproxy.h index 1e013f7c..7f2a1ddc 100644 --- a/src/common/signalproxy.h +++ b/src/common/signalproxy.h @@ -1,128 +1,311 @@ -/**************************************************************************** - ** - ** Copyright (C) Qxt Foundation. Some rights reserved. - ** - ** This file is part of the QxtNetwork module of the Qt eXTension library - ** - ** This library is free software; you can redistribute it and/or modify it - ** under the terms of th Common Public License, version 1.0, as published by - ** IBM. - ** - ** This file is provided "AS IS", without WARRANTIES OR CONDITIONS OF ANY - ** KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY - ** WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR - ** FITNESS FOR A PARTICULAR PURPOSE. - ** - ** You should have received a copy of the CPL along with this file. - ** See the LICENSE file and the cpl1.0.txt file included with the source - ** distribution for more information. If you did not receive a copy of the - ** license, contact the Qxt Foundation. - ** - ** - ** - ****************************************************************************/ - -#ifndef _SIGNALPROXY_H_ -#define _SIGNALPROXY_H_ - -#include +/*************************************************************************** + * Copyright (C) 2005-09 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) version 3. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * 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. * + ***************************************************************************/ + +#ifndef SIGNALPROXY_H +#define SIGNALPROXY_H + +#include #include #include #include +#include #include #include #include +#include -class ClassIntrospector; +class SyncableObject; +struct QMetaObject; class SignalProxy : public QObject { Q_OBJECT + class AbstractPeer; + class IODevicePeer; + class SignalProxyPeer; + + class SignalRelay; + public: - enum RPCTypes { + enum ProxyMode { Server, - Client, - Peer + Client + }; + + enum RequestType { + Sync = 1, + RpcCall, + InitRequest, + InitData, + HeartBeat, + HeartBeatReply + }; + + enum ClientConnectionType { + SignalProxyConnection, + IODeviceConnection + }; + + enum CustomEvents { + PeerSignal = QEvent::User, + RemovePeer }; - SignalProxy(QObject* parent); - SignalProxy(RPCTypes type, QObject* parent); - SignalProxy(RPCTypes type, QIODevice* device, QObject* parent); + SignalProxy(QObject *parent); + SignalProxy(ProxyMode mode, QObject *parent); + SignalProxy(ProxyMode mode, QIODevice *device, QObject *parent); virtual ~SignalProxy(); - void setRPCType(RPCTypes type); - RPCTypes rpcType() const; + void setProxyMode(ProxyMode mode); + 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); + + //! 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); - bool attachSignal(QObject* sender, const char* signal, const QByteArray& rpcFunction = QByteArray()); - bool attachSlot(const QByteArray& rpcFunction, QObject* recv, const char* slot); + //! 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); + 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 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(QObject *obj); + +protected: + void customEvent(QEvent *event); + void syncCall(const SyncableObject *obj, ProxyMode modeType, const char *funcname, va_list ap); - static void writeDataToDevice(QIODevice *dev, const QVariant &item); - static bool readDataFromDevice(QIODevice *dev, quint32 &blockSize, QVariant &item); - - const QList &argTypes(QObject* obj, int methodId); - const QByteArray &methodName(QObject* obj, int methodId); - - typedef QHash > ArgHash; - typedef QHash MethodNameHash; - struct ClassInfo { - ArgHash argTypes; - MethodNameHash methodNames; - // QHash syncMap - }; - 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 createClassInfo(QObject *obj); - void setArgTypes(QObject* obj, int methodId); - void setMethodName(QObject* obj, int methodId); - - void receivePeerSignal(const QVariant &packedFunc); + void init(); + void initServer(); + void initClient(); + + 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 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: + static void disconnectDevice(QIODevice *dev, const QString &reason = QString()); - void _detachSignals(QObject *sender); - void _detachSlots(QObject *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; - - // we use one introSpector per QObject - QHash _specHash; + QHash _extendedMetaObjects; + + // SignalRelay for all manually attached signals + SignalRelay *_signalRelay; // RPC function -> (object, slot ID) typedef QPair MethodId; typedef QMultiHash SlotHash; SlotHash _attachedSlots; + + // slaves for sync + typedef QHash ObjectId; + QHash _syncSlave; + + + 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); - // Hash of used QIODevices - QHash _peerByteCount; + const QMetaObject *_meta; + int _updatedRemotelyId; // id of the updatedRemotely() signal - makes things faster - int _rpcType; - int _maxClients; + 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