/***************************************************************************
- * Copyright (C) 2005-2012 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 *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
***************************************************************************/
-#ifndef SIGNALPROXY_H
-#define SIGNALPROXY_H
+#pragma once
+
+#include "common-export.h"
#include <QEvent>
-#include <QList>
-#include <QHash>
-#include <QVariant>
-#include <QVariantMap>
-#include <QPair>
-#include <QString>
-#include <QByteArray>
-#include <QTimer>
+#include <QSet>
+
+#include <functional>
+#include <initializer_list>
+
+#include "protocol.h"
-class SyncableObject;
struct QMetaObject;
+class QIODevice;
-class SignalProxy : public QObject
+class Peer;
+class SyncableObject;
+
+class COMMON_EXPORT SignalProxy : public QObject
{
Q_OBJECT
- class AbstractPeer;
- class IODevicePeer;
- class SignalProxyPeer;
-
class SignalRelay;
public:
Client
};
- enum RequestType {
- Sync = 1,
- RpcCall,
- InitRequest,
- InitData,
- HeartBeat,
- HeartBeatReply
- };
-
- enum ClientConnectionType {
- SignalProxyConnection,
- IODeviceConnection
- };
-
- enum CustomEvents {
- PeerSignal = QEvent::User,
- RemovePeer
+ enum EventType {
+ RemovePeerEvent = QEvent::User
};
SignalProxy(QObject *parent);
SignalProxy(ProxyMode mode, QObject *parent);
- SignalProxy(ProxyMode mode, QIODevice *device, QObject *parent);
- virtual ~SignalProxy();
+ ~SignalProxy() override;
void setProxyMode(ProxyMode mode);
inline ProxyMode proxyMode() const { return _proxyMode; }
void setMaxHeartBeatCount(int max);
inline int maxHeartBeatCount() const { return _maxHeartBeatCount; }
- bool addPeer(QIODevice *iodev);
- bool addPeer(SignalProxy *proxy);
- void removePeer(QObject *peer);
- void removeAllPeers();
+ 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);
- //! 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);
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<Peer*> peers, std::function<void()> closure);
+ void restrictTargetPeers(Peer *peer, std::function<void()> closure) {
+ QSet<Peer*> 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<Peer*> peers, std::function<void()> closure) {
+ restrictTargetPeers(QSet<Peer*>(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 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);
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();
signals:
- void peerRemoved(QIODevice *dev);
+ void peerRemoved(Peer *peer);
void connected();
void disconnected();
void objectInitialized(SyncableObject *);
+ void heartBeatIntervalChanged(int secs);
+ void maxHeartBeatCountChanged(int max);
void lagUpdated(int lag);
- void securityChanged(bool);
void secureStateChanged(bool);
private:
+ template<class T>
+ class PeerMessageEvent;
+
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 removePeer(Peer *peer);
+ void removeAllPeers();
+
+ int nextPeerId() {
+ return _lastPeerId++;
+ }
+
+ template<class T>
+ void dispatch(const T &protoMessage);
+ template<class T>
+ void dispatch(Peer *peer, const T &protoMessage);
- 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 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);
- bool invokeSlot(QObject *receiver, int methodId, const QVariantList ¶ms, QVariant &returnValue);
- bool invokeSlot(QObject *receiver, int methodId, const QVariantList ¶ms = QVariantList());
+ template<class T>
+ void handle(Peer *, T) { Q_ASSERT(0); }
+
+ 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);
- 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());
- // 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<QObject *, AbstractPeer *> PeerHash;
- PeerHash _peers;
+ QHash<int, Peer*> _peerMap;
// containg a list of argtypes for fast access
QHash<const QMetaObject *, ExtendedMetaObject *> _extendedMetaObjects;
SignalRelay *_signalRelay;
// RPC function -> (object, slot ID)
- typedef QPair<QObject *, int> MethodId;
- typedef QMultiHash<QByteArray, MethodId> SlotHash;
+ using MethodId = QPair<QObject *, int>;
+ using SlotHash = QMultiHash<QByteArray, MethodId>;
SlotHash _attachedSlots;
// slaves for sync
- typedef QHash<QString, SyncableObject *> ObjectId;
+ using ObjectId = QHash<QString, SyncableObject *>;
QHash<QByteArray, ObjectId> _syncSlave;
ProxyMode _proxyMode;
- QTimer _heartBeatTimer;
int _heartBeatInterval;
int _maxHeartBeatCount;
bool _secure; // determines if all connections are in a secured state (using ssl or internal connections)
+ int _lastPeerId = 0;
+
+ QSet<Peer *> _restrictedTargets;
+ bool _restrictMessageTarget = false;
+
+ Peer *_sourcePeer = nullptr;
+ Peer *_targetPeer = nullptr;
+
friend class SignalRelay;
friend class SyncableObject;
+ friend class Peer;
};
{
class MethodDescriptor
{
-public:
+ public:
MethodDescriptor(const QMetaMethod &method);
- MethodDescriptor() : _returnType(-1), _minArgCount(-1), _receiverMode(SignalProxy::Client) {}
+ MethodDescriptor() {}
inline const QByteArray &methodName() const { return _methodName; }
inline const QList<int> &argTypes() const { return _argTypes; }
inline int minArgCount() const { return _minArgCount; }
inline SignalProxy::ProxyMode receiverMode() const { return _receiverMode; }
-private:
+ private:
QByteArray _methodName;
QList<int> _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.
};
QHash<QByteArray, int> _methodIds;
QHash<int, int> _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
projects / quassel.git / blobdiff