X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Fsignalproxy.h;h=a94861713387f5dc2435b7f8c49ef7c59df473b5;hp=d446fefc86460aa15c87af130ab7b18d41a4bbf6;hb=158443f71d48215eea8b47b836b61afd77654b78;hpb=4c80eeb2d07b5ca75fd399b51c939961fdff1670 diff --git a/src/common/signalproxy.h b/src/common/signalproxy.h index d446fefc..a9486171 100644 --- a/src/common/signalproxy.h +++ b/src/common/signalproxy.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-2013 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 * @@ -18,36 +18,31 @@ * 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 "protocol.h" -class SyncableObject; struct QMetaObject; +class QIODevice; +class Peer; +class SyncableObject; -class SignalProxy : public QObject +class COMMON_EXPORT SignalProxy : public QObject { Q_OBJECT class SignalRelay; public: - class AbstractPeer; - enum ProxyMode { Server, Client @@ -59,7 +54,7 @@ public: SignalProxy(QObject *parent); SignalProxy(ProxyMode mode, QObject *parent); - virtual ~SignalProxy(); + ~SignalProxy() override; void setProxyMode(ProxyMode mode); inline ProxyMode proxyMode() const { return _proxyMode; } @@ -69,7 +64,7 @@ public: void setMaxHeartBeatCount(int max); inline int maxHeartBeatCount() const { return _maxHeartBeatCount; } - bool addPeer(AbstractPeer *peer); + 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); @@ -86,7 +81,46 @@ public: bool isSecure() const { return _secure; } void dumpProxyStats(); void dumpSyncMap(SyncableObject *object); - inline int peerCount() const { return _peers.size(); } + + 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); @@ -94,7 +128,7 @@ public slots: void detachSlots(QObject *receiver); protected: - void customEvent(QEvent *event); + 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); @@ -104,7 +138,7 @@ private slots: void updateSecureState(); signals: - void peerRemoved(SignalProxy::AbstractPeer *peer); + void peerRemoved(Peer *peer); void connected(); void disconnected(); void objectInitialized(SyncableObject *); @@ -123,19 +157,28 @@ private: static const QMetaObject *metaObject(const QObject *obj); - void removePeer(AbstractPeer *peer); + void removePeer(Peer *peer); void removeAllPeers(); + int nextPeerId() { + return _lastPeerId++; + } + template void dispatch(const T &protoMessage); + template + void dispatch(Peer *peer, 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); + 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 ¶ms, QVariant &returnValue); - bool invokeSlot(QObject *receiver, int methodId, const QVariantList ¶ms = QVariantList()); + 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; @@ -143,7 +186,7 @@ private: static void disconnectDevice(QIODevice *dev, const QString &reason = QString()); - QSet _peers; + QHash _peerMap; // containg a list of argtypes for fast access QHash _extendedMetaObjects; @@ -152,12 +195,12 @@ private: SignalRelay *_signalRelay; // RPC function -> (object, slot ID) - typedef QPair MethodId; - typedef QMultiHash SlotHash; + using MethodId = QPair; + using SlotHash = QMultiHash; SlotHash _attachedSlots; // slaves for sync - typedef QHash ObjectId; + using ObjectId = QHash; QHash _syncSlave; ProxyMode _proxyMode; @@ -166,10 +209,17 @@ private: bool _secure; // determines if all connections are in a secured state (using ssl or internal connections) + int _lastPeerId = 0; + + QSet _restrictedTargets; + bool _restrictMessageTarget = false; + + Peer *_sourcePeer = nullptr; + Peer *_targetPeer = nullptr; + friend class SignalRelay; friend class SyncableObject; - friend class InternalPeer; - friend class RemotePeer; + friend class Peer; }; @@ -182,7 +232,7 @@ class SignalProxy::ExtendedMetaObject { public: MethodDescriptor(const QMetaMethod &method); - MethodDescriptor() : _returnType(-1), _minArgCount(-1), _receiverMode(SignalProxy::Client) {} + MethodDescriptor() {} inline const QByteArray &methodName() const { return _methodName; } inline const QList &argTypes() const { return _argTypes; } @@ -193,9 +243,9 @@ class SignalProxy::ExtendedMetaObject 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. + 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. }; @@ -230,43 +280,3 @@ private: QHash _methodIds; QHash _receiveMap; // if slot x is called then hand over the result to slot y }; - - -// ================================================== -// 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; - - 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