X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Fsignalproxy.h;h=b58aae8f1a9cdba0e1c9577447d03a3507883c56;hp=a76a352017ceafbf46ae510e38df4b2748b94260;hb=a22e08480288685d73d9abd18c6a1087451c388b;hpb=57e1cccf5a990b83bc8bde7959e85dec99db50a7 diff --git a/src/common/signalproxy.h b/src/common/signalproxy.h index a76a3520..b58aae8f 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,296 +15,474 @@ * 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 -#include -#include -#include +#include +#include +#include + +#include "funchelpers.h" +#include "protocol.h" +#include "types.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; + template::FunctionType> + class SlotObject; + class SlotObjectBase; 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); - - //! 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); - 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); + 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); + + /** + * Attaches a signal for remote emission. + * + * After calling this method, whenever the sender emits the given signal, an RpcCall message is sent to connected peers. + * On the other end, a slot can be attached to handle this message by calling attachSlot(). + + * By default, the signal name being sent is as if the SIGNAL() macro had been used, i.e. the normalized signature prefixed with a '2'. + * This can be overridden by explicitly providing the signalName argument. + * + * @sa attachSlot + * + * @param sender The sender of the signal + * @param signal The signal itself (given as a member function pointer) + * @param signalName Optional string to be used instead of the actual signal name. Will be normalized. + * @returns true if attaching the signal was successful + */ + template + bool attachSignal(const typename FunctionTraits::ClassType* sender, Signal signal, const QByteArray& signalName = {}); + + /** + * Attaches a slot to a remote signal. + * + * After calling this method, upon receipt of an RpcCall message with a signalName matching the signalName parameter, the given slot + * is called with the parameters contained in the message. This is intended to be used in conjunction with attachSignal() on the other + * end of the connection. + * + * Normally, the signalName should be given using the SIGNAL() macro; it will be normalized automatically. + * + * @sa attachSignal + * + * @param signalName Name of the signal as stored in the RpcCall message + * @param receiver Receiver of the signal + * @param slot Slot to be called (given as a member function pointer) + * @returns true if attaching the slot was successful + */ + template::value>> + bool attachSlot(const QByteArray& signalName, typename FunctionTraits::ClassType* receiver, Slot slot); + + /** + * @overload + * + * Attaches a functor to a remote signal. + * + * After calling this method, upon receipt of an RpcCall message with a signalName matching the signalName parameter, the given functor + * is invoked with the parameters contained in the message. This is intended to be used in conjunction with attachSignal() on the other + * end of the connection. This overload can be used, for example, with a lambda that accepts arguments matching the RpcCall parameter + * list. + * + * The context parameter controls the lifetime of the connection; if the context is deleted, the functor is deleted as well. + * + * @sa attachSignal + * + * @param signalName Name of the signal as stored in the RpcCall message + * @param context QObject context controlling the lifetime of the callable + * @param slot The functor to be invoked + * @returns true if attaching the functor was successful + */ + template::value>> + bool attachSlot(const QByteArray& signalName, const QObject* context, Slot 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); protected: - void customEvent(QEvent *event); - void syncCall(const SyncableObject *obj, ProxyMode modeType, const char *funcname, va_list ap); + 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 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(); + 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; + + void init(); + void initServer(); + void initClient(); + + static const QMetaObject* metaObject(const QObject* obj); + + void removePeer(Peer* peer); + void removeAllPeers(); + + int nextPeerId() { return _lastPeerId++; } + + /** + * Attaches a SlotObject for the given signal name. + * + * @param signalName Signal name to be associated with the SlotObject + * @param slotObject The SlotObject instance to be invoked for incoming and matching RpcCall messages + */ + void attachSlotObject(const QByteArray& signalName, std::unique_ptr slotObject); + + /** + * Deletes all SlotObjects associated with the given context. + * + * @param context The context + */ + void detachSlotObjects(const QObject* context); + + /** + * Dispatches an RpcMessage for the given signal and parameters. + * + * @param signalName The signal + * @param params The parameters + */ + void dispatchSignal(QByteArray signalName, QVariantList params); + + template + void dispatch(const T& protoMessage); + template + void dispatch(Peer* peer, const T& protoMessage); + + 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); + + template + void handle(Peer*, T) + { + Q_ASSERT(0); + } + + bool invokeSlot(QObject* receiver, int methodId, const QVariantList& params, QVariant& returnValue, Peer* peer = nullptr); + bool invokeSlot(QObject* receiver, int methodId, const QVariantList& params = QVariantList(), Peer* peer = nullptr); + + 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()); - 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); +private: + QHash _peerMap; - 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); + // containg a list of argtypes for fast access + QHash _extendedMetaObjects; - bool invokeSlot(QObject *receiver, int methodId, const QVariantList ¶ms, QVariant &returnValue); - bool invokeSlot(QObject *receiver, int methodId, const QVariantList ¶ms = QVariantList()); + std::unordered_multimap, Hash> _attachedSlots; ///< Attached slot objects - void requestInit(SyncableObject *obj); - QVariantMap initData(SyncableObject *obj) const; - void setInitData(SyncableObject *obj, const QVariantMap &properties); + // slaves for sync + using ObjectId = QHash; + QHash _syncSlave; - void updateLag(IODevicePeer *peer, int lag); + ProxyMode _proxyMode; + int _heartBeatInterval; + int _maxHeartBeatCount; -public: - void dumpSyncMap(SyncableObject *object); - inline int peerCount() const { return _peers.size(); } - -private: - static void disconnectDevice(QIODevice *dev, const QString &reason = QString()); + bool _secure; // determines if all connections are in a secured state (using ssl or internal connections) - // 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; + int _lastPeerId = 0; - // containg a list of argtypes for fast access - QHash _extendedMetaObjects; + QSet _restrictedTargets; + bool _restrictMessageTarget = false; - // SignalRelay for all manually attached signals - SignalRelay *_signalRelay; + Peer* _sourcePeer = nullptr; + Peer* _targetPeer = nullptr; - // RPC function -> (object, slot ID) - typedef QPair MethodId; - typedef QMultiHash SlotHash; - SlotHash _attachedSlots; + friend class SyncableObject; + friend class Peer; +}; - // slaves for sync - typedef QHash ObjectId; - QHash _syncSlave; +// ---- Template function implementations --------------------------------------- + +template +bool SignalProxy::attachSignal(const typename FunctionTraits::ClassType* sender, Signal signal, const QByteArray& signalName) +{ + static_assert(std::is_member_function_pointer::value, "Signal must be given as member function pointer"); + + // Determine the signalName to be stored in the RpcCall + QByteArray name; + if (signalName.isEmpty()) { + auto method = QMetaMethod::fromSignal(signal); + if (!method.isValid()) { + qWarning().nospace() << Q_FUNC_INFO << ": Function pointer is not a signal"; + return false; + } + name = "2" + method.methodSignature(); // SIGNAL() prefixes the signature with "2" + } + else { + name = QMetaObject::normalizedSignature(signalName.constData()); + } + + // Upon signal emission, marshall the signal's arguments into a QVariantList and dispatch an RpcCall message + connect(sender, signal, this, [this, signalName = std::move(name)](auto&&... args) { + this->dispatchSignal(std::move(signalName), {QVariant::fromValue(args)...}); + }); + + return true; +} + +template +bool SignalProxy::attachSlot(const QByteArray& signalName, typename FunctionTraits::ClassType* receiver, Slot slot) +{ + // Create a wrapper function that invokes the member function pointer for the receiver instance + attachSlotObject(signalName, std::make_unique>(receiver, [receiver, slot = std::move(slot)](auto&&... args) { + (receiver->*slot)(std::forward(args)...); + })); + return true; +} + +template +bool SignalProxy::attachSlot(const QByteArray& signalName, const QObject* context, Slot slot) +{ + static_assert(!std::is_same::value, "Old-style slots not supported"); + + attachSlotObject(signalName, std::make_unique>(context, std::move(slot))); + return true; +} + +/** + * Base object for storing a slot (or functor) to be invoked with a list of arguments. + * + * @note Having this untemplated base class for SlotObject allows for handling slots in the implementation rather than in the header. + */ +class COMMON_EXPORT SignalProxy::SlotObjectBase +{ +public: + virtual ~SlotObjectBase() = default; + + /** + * @returns The context associated with the slot + */ + const QObject* context() const; + + /** + * Invokes the slot with the given list of parameters. + * + * If the parameters cannot all be converted to the slot's argument types, or there is a mismatch in argument count, + * the invocation will fail. + * + * @param params List of arguments marshalled as QVariants + * @returns true if the invocation was successful + */ + virtual bool invoke(const QVariantList& params) const = 0; +protected: + SlotObjectBase(const QObject* context); - ProxyMode _proxyMode; - QTimer _heartBeatTimer; +private: + const QObject* _context; +}; - bool _secure; // determines if all connections are in a secured state (using ssl or internal connections) +/** + * Specialization of SlotObjectBase for a particular type of slot. + * + * Callable may be a function wrapper around a member function pointer of type Slot, + * or a functor that can be invoked directly. + * + * @tparam Slot Type of the slot, used for determining the callable's signature + * @tparam Callable Type of the actual callable to be invoked + */ +template +class SignalProxy::SlotObject : public SlotObjectBase +{ +public: + /** + * Constructs a SlotObject for the given callable, whose lifetime is controlled by context. + * + * @param context Context object; if destroyed, the slot object will be destroyed as well by SignalProxy. + * @param callable Callable to be invoked + */ + SlotObject(const QObject* context, Callable callable) + : SlotObjectBase(context) + , _callable(std::move(callable)) + {} + + // See base class + bool invoke(const QVariantList& params) const override + { + if (QThread::currentThread() != context()->thread()) { + qWarning() << "Cannot call slot in different thread!"; + return false; + } + return invokeWithArgsList(_callable, params) ? true : false; + } - friend class SignalRelay; - friend class SyncableObject; +private: + Callable _callable; }; - // ================================================== // ExtendedMetaObject // ================================================== -class SignalProxy::ExtendedMetaObject { - class MethodDescriptor { - public: - MethodDescriptor(const QMetaMethod &method); - MethodDescriptor() : _returnType(-1), _minArgCount(-1) {} - - 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; } - - private: - QByteArray _methodName; - QList _argTypes; - int _returnType; - int _minArgCount; - }; +class SignalProxy::ExtendedMetaObject +{ + class MethodDescriptor + { + public: + MethodDescriptor(const QMetaMethod& method); + MethodDescriptor() = default; + + 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{-1}; + int _minArgCount{-1}; + SignalProxy::ProxyMode _receiverMode{ + SignalProxy::Client}; // 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 int updatedRemotelyId() { return _updatedRemotelyId; } - - int methodId(const QByteArray &methodName); - const QHash &syncMap(); - const QHash &receiveMap(); + ExtendedMetaObject(const QMetaObject* meta, bool checkConflicts); - const QMetaObject *metaObject() const { return _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(); } - static QByteArray methodName(const QMetaMethod &method); - static bool methodsMatch(const QMetaMethod &signal, const QMetaMethod &slot); - static QString methodBaseName(const QMetaMethod &method); + inline int methodId(const QByteArray& methodName) { return _methodIds.contains(methodName) ? _methodIds[methodName] : -1; } -private: - const MethodDescriptor &methodDescriptor(int methodId); - - const QMetaObject *_meta; - QHash _methods; - QHash _methodIds; + inline int updatedRemotelyId() { return _updatedRemotelyId; } - int _updatedRemotelyId; // id of the updatedRemotely() signal - makes things faster + inline const QHash& slotMap() { return _methodIds; } + const QHash& receiveMap(); - QHash _syncMap; - QHash _receiveMap; -}; + 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