X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Fsignalproxy.h;h=dddb785bdaa83d548f0af13c56f85bb36dc528ed;hp=1090547e3fbf6909d0f55bc6e8ea8955c1c89f89;hb=a4568e36edde5b86feeaae740a396f1bcaca1967;hpb=ce42a143c25a386d386a8725d422cae36da01b3c diff --git a/src/common/signalproxy.h b/src/common/signalproxy.h index 1090547e..dddb785b 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-2012 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -15,176 +15,258 @@ * 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 +#include #include #include #include #include #include +#include #include #include #include -class SignalRelay; +#include "protocol.h" + class SyncableObject; struct 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 &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; - }; - - void dumpProxyStats(); - + class AbstractPeer; + + 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(AbstractPeer *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(SignalProxy::AbstractPeer *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 PeerMessageEvent; + + void init(); + void initServer(); + void initClient(); + + static const QMetaObject *metaObject(const QObject *obj); + + void removePeer(AbstractPeer *peer); + void removeAllPeers(); + + template + void dispatch(const T &protoMessage); + + void handle(AbstractPeer *peer, const Protocol::SyncMessage &syncMessage); + void handle(AbstractPeer *peer, const Protocol::RpcCall &rpcCall); + void handle(AbstractPeer *peer, const Protocol::InitRequest &initRequest); + void handle(AbstractPeer *peer, const Protocol::InitData &initData); + + 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); + + static void disconnectDevice(QIODevice *dev, const QString &reason = QString()); + + QSet _peers; + + // containg a list of argtypes for fast access + 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; + 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 InternalConnection; + friend class RemoteConnection; +}; + + +// ================================================== +// 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: - void dumpSyncMap(SyncableObject *object); - + ExtendedMetaObject(const QMetaObject *meta, bool checkConflicts); + + 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 methodBaseName(const QMetaMethod &method); + private: - // Hash of used QIODevices - QHash _peerByteCount; + const MethodDescriptor &methodDescriptor(int methodId); - // containg a list of argtypes for fast access - QHash _classInfo; + const QMetaObject *_meta; + int _updatedRemotelyId; // id of the updatedRemotely() signal - makes things faster - // we use one SignalRelay per QObject - QHash _relayHash; + QHash _methods; + QHash _methodIds; + QHash _receiveMap; // if slot x is called then hand over the result to slot y +}; - // RPC function -> (object, slot ID) - typedef QPair MethodId; - typedef QMultiHash SlotHash; - SlotHash _attachedSlots; - // slaves for sync - typedef QHash ObjectId; - QHash _syncSlave; +// ================================================== +// AbstractPeer +// ================================================== +class SignalProxy::AbstractPeer : public QObject +{ + Q_OBJECT + +public: + AbstractPeer(QObject *parent = 0) : QObject(parent) {} + + virtual QString description() const = 0; + virtual void setSignalProxy(SignalProxy *proxy) = 0; - ProxyMode _proxyMode; - QTimer _heartBeatTimer; - - friend class SignalRelay; + virtual bool isOpen() const = 0; + virtual bool isSecure() const = 0; + virtual bool isLocal() const = 0; + + virtual QString errorString() const { return QString(); } + + virtual int lag() const = 0; + +public slots: + virtual void dispatch(const Protocol::SyncMessage &msg) = 0; + virtual void dispatch(const Protocol::RpcCall &msg) = 0; + virtual void dispatch(const Protocol::InitRequest &msg) = 0; + virtual void dispatch(const Protocol::InitData &msg) = 0; + + virtual void close(const QString &reason = QString()) = 0; + +signals: + void disconnected(); + void error(QAbstractSocket::SocketError); + void secureStateChanged(bool secure = true); + void lagUpdated(int msecs); }; #endif