X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Fsignalproxy.h;h=935df5e9cd0810dbb5a46ef58c785f4faaefa3a5;hp=357c29bb73091885e08046ed0f68208260750645;hb=e8a39b4c3c92e193ab861a3fea84a261bb6fbd24;hpb=27de4d2719454c4deb5f6e24b82bdd8991e45260 diff --git a/src/common/signalproxy.h b/src/common/signalproxy.h index 357c29bb..935df5e9 100644 --- a/src/common/signalproxy.h +++ b/src/common/signalproxy.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-09 by the Quassel Project * + * Copyright (C) 2005-2018 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -15,297 +15,268 @@ * 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 +#pragma once + +#include "common-export.h" #include -#include -#include -#include -#include -#include -#include -#include -#include +#include + +#include +#include + +#include "protocol.h" -class SyncableObject; struct QMetaObject; +class QIODevice; -class SignalProxy : public QObject { - Q_OBJECT +class Peer; +class SyncableObject; - class AbstractPeer; - class IODevicePeer; - class SignalProxyPeer; +class COMMON_EXPORT SignalProxy : public QObject +{ + Q_OBJECT - class SignalRelay; + class SignalRelay; public: - enum ProxyMode { - Server, - Client - }; - - 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); - inline ProxyMode proxyMode() const { return _proxyMode; } - - bool addPeer(QIODevice *iodev); - 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 stopSynchronize(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); - - 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(); + enum ProxyMode { + Server, + Client + }; + + enum EventType { + RemovePeerEvent = QEvent::User + }; + + SignalProxy(QObject *parent); + SignalProxy(ProxyMode mode, QObject *parent); + ~SignalProxy() override; + + 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(Peer *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); + + static SignalProxy *current(); + + /**@{*/ + /** + * This method allows to send a signal only to a limited set of peers + * @param peers A list of peers that should receive it + * @param closure Code you want to execute within of that restricted environment + */ + void restrictTargetPeers(QSet peers, std::function closure); + void restrictTargetPeers(Peer *peer, std::function closure) { + QSet set; + set.insert(peer); + restrictTargetPeers(set, std::move(closure)); + } + + //A better version, but only implemented on Qt5 if Initializer Lists exist +#ifdef Q_COMPILER_INITIALIZER_LISTS + void restrictTargetPeers(std::initializer_list peers, std::function closure) { + restrictTargetPeers(QSet(peers), std::move(closure)); + } +#endif + /**}@*/ + + inline int peerCount() const { return _peerMap.size(); } + QVariantList peerData(); + + Peer *peerById(int peerId); + + /** + * @return If handling a signal, the Peer from which the current signal originates + */ + Peer *sourcePeer(); + void setSourcePeer(Peer *sourcePeer); + + /** + * @return If sending a signal, the Peer to which the current signal is directed + */ + Peer *targetPeer(); + void setTargetPeer(Peer *targetPeer); public slots: - void detachObject(QObject *obj); - void detachSignals(QObject *sender); - void detachSlots(QObject *receiver); + 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); + void customEvent(QEvent *event) override; + 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 removePeerBySender(); - 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(); + void removePeerBySender(); + void objectRenamed(const QByteArray &classname, const QString &newname, const QString &oldname); + void updateSecureState(); signals: - void peerRemoved(QIODevice *dev); - void connected(); - void disconnected(); - void objectInitialized(SyncableObject *); - void lagUpdated(int lag); - void securityChanged(bool); - void secureStateChanged(bool); + void peerRemoved(Peer *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 init(); - void initServer(); - void initClient(); + template + class PeerMessageEvent; - static const QMetaObject *metaObject(const QObject *obj); + void init(); + void initServer(); + void initClient(); - void dispatchSignal(QIODevice *receiver, const RequestType &requestType, const QVariantList ¶ms); - void dispatchSignal(const RequestType &requestType, const QVariantList ¶ms); + static const QMetaObject *metaObject(const QObject *obj); - 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); + void removePeer(Peer *peer); + void removeAllPeers(); - bool invokeSlot(QObject *receiver, int methodId, const QVariantList ¶ms, QVariant &returnValue); - bool invokeSlot(QObject *receiver, int methodId, const QVariantList ¶ms = QVariantList()); + int nextPeerId() { + return _lastPeerId++; + } - void requestInit(SyncableObject *obj); - QVariantMap initData(SyncableObject *obj) const; - void setInitData(SyncableObject *obj, const QVariantMap &properties); + template + void dispatch(const T &protoMessage); + template + void dispatch(Peer *peer, const T &protoMessage); - void updateLag(IODevicePeer *peer, int lag); + void handle(Peer *peer, const Protocol::SyncMessage &syncMessage); + void handle(Peer *peer, const Protocol::RpcCall &rpcCall); + void handle(Peer *peer, const Protocol::InitRequest &initRequest); + void handle(Peer *peer, const Protocol::InitData &initData); -public: - void dumpSyncMap(SyncableObject *object); - inline int peerCount() const { return _peers.size(); } + template + void handle(Peer *, T) { Q_ASSERT(0); } -private: - static void disconnectDevice(QIODevice *dev, const QString &reason = QString()); + bool invokeSlot(QObject *receiver, int methodId, const QVariantList ¶ms, QVariant &returnValue, Peer *peer = nullptr); + bool invokeSlot(QObject *receiver, int methodId, const QVariantList ¶ms = QVariantList(), Peer *peer = nullptr); + + void requestInit(SyncableObject *obj); + QVariantMap initData(SyncableObject *obj) const; + void setInitData(SyncableObject *obj, const QVariantMap &properties); - // 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; + static void disconnectDevice(QIODevice *dev, const QString &reason = QString()); - // containg a list of argtypes for fast access - QHash _extendedMetaObjects; + QHash _peerMap; - // SignalRelay for all manually attached signals - SignalRelay *_signalRelay; + // containg a list of argtypes for fast access + QHash _extendedMetaObjects; - // RPC function -> (object, slot ID) - typedef QPair MethodId; - typedef QMultiHash SlotHash; - SlotHash _attachedSlots; + // SignalRelay for all manually attached signals + SignalRelay *_signalRelay; - // slaves for sync - typedef QHash ObjectId; - QHash _syncSlave; + // 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; + ProxyMode _proxyMode; + int _heartBeatInterval; + int _maxHeartBeatCount; - bool _secure; // determines if all connections are in a secured state (using ssl or internal connections) + bool _secure; // determines if all connections are in a secured state (using ssl or internal connections) - friend class SignalRelay; - friend class SyncableObject; + int _lastPeerId = 0; + + QSet _restrictedTargets; + bool _restrictMessageTarget = false; + + Peer *_sourcePeer = nullptr; + Peer *_targetPeer = nullptr; + + friend class SignalRelay; + friend class SyncableObject; + friend class Peer; }; // ================================================== // 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. - }; +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, 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; } +public: + ExtendedMetaObject(const QMetaObject *meta, bool checkConflicts); - inline int updatedRemotelyId() { return _updatedRemotelyId; } - - inline const QHash &slotMap() { return _methodIds; } - const QHash &receiveMap(); + 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(); } - const QMetaObject *metaObject() const { return _meta; } + inline int methodId(const QByteArray &methodName) { return _methodIds.contains(methodName) ? _methodIds[methodName] : -1; } - static QByteArray methodName(const QMetaMethod &method); - static QString ExtendedMetaObject::methodBaseName(const QMetaMethod &method); + inline int updatedRemotelyId() { return _updatedRemotelyId; } -private: - const MethodDescriptor &methodDescriptor(int methodId); + inline const QHash &slotMap() { return _methodIds; } + const QHash &receiveMap(); - 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 -}; + const QMetaObject *metaObject() const { return _meta; } + static QByteArray methodName(const QMetaMethod &method); + static QString methodBaseName(const QMetaMethod &method); -// ================================================== -// 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; -}; + const MethodDescriptor &methodDescriptor(int methodId); -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; -}; + const QMetaObject *_meta; + int _updatedRemotelyId; // id of the updatedRemotely() signal - makes things faster -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; + QHash _methods; + QHash _methodIds; + QHash _receiveMap; // if slot x is called then hand over the result to slot y }; - -#endif