/***************************************************************************
- * 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 *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
***************************************************************************/
-#ifndef SIGNALPROXY_H
-#define SIGNALPROXY_H
+#pragma once
+
+#include "common-export.h"
-#include <QAbstractSocket>
#include <QEvent>
-#include <QList>
-#include <QHash>
-#include <QVariant>
-#include <QVariantMap>
-#include <QPair>
#include <QSet>
-#include <QString>
-#include <QByteArray>
-#include <QTimer>
+
+#include <functional>
+#include <initializer_list>
#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
SignalProxy(QObject *parent);
SignalProxy(ProxyMode mode, 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(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);
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<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);
void updateSecureState();
signals:
- void peerRemoved(SignalProxy::AbstractPeer *peer);
+ void peerRemoved(Peer *peer);
void connected();
void disconnected();
void objectInitialized(SyncableObject *);
static const QMetaObject *metaObject(const QObject *obj);
- void removePeer(AbstractPeer *peer);
+ 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 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<class T>
+ 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;
static void disconnectDevice(QIODevice *dev, const QString &reason = QString());
- QSet<AbstractPeer *> _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;
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 InternalPeer;
- friend class RemotePeer;
+ friend class Peer;
};
{
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; }
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
};
-
-
-// ==================================================
-// 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
projects / quassel.git / blobdiff