1 /***************************************************************************
2 * Copyright (C) 2005-2016 by the Quassel Project *
3 * devel@quassel-irc.org *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) version 3. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
35 class SignalProxy : public QObject
48 RemovePeerEvent = QEvent::User
51 SignalProxy(QObject *parent);
52 SignalProxy(ProxyMode mode, QObject *parent);
53 virtual ~SignalProxy();
55 void setProxyMode(ProxyMode mode);
56 inline ProxyMode proxyMode() const { return _proxyMode; }
58 void setHeartBeatInterval(int secs);
59 inline int heartBeatInterval() const { return _heartBeatInterval; }
60 void setMaxHeartBeatCount(int max);
61 inline int maxHeartBeatCount() const { return _maxHeartBeatCount; }
63 bool addPeer(Peer *peer);
65 bool attachSignal(QObject *sender, const char *signal, const QByteArray &sigName = QByteArray());
66 bool attachSlot(const QByteArray &sigName, QObject *recv, const char *slot);
68 void synchronize(SyncableObject *obj);
69 void stopSynchronize(SyncableObject *obj);
71 class ExtendedMetaObject;
72 ExtendedMetaObject *extendedMetaObject(const QMetaObject *meta) const;
73 ExtendedMetaObject *createExtendedMetaObject(const QMetaObject *meta, bool checkConflicts = false);
74 inline ExtendedMetaObject *extendedMetaObject(const QObject *obj) const { return extendedMetaObject(metaObject(obj)); }
75 inline ExtendedMetaObject *createExtendedMetaObject(const QObject *obj, bool checkConflicts = false) { return createExtendedMetaObject(metaObject(obj), checkConflicts); }
77 bool isSecure() const { return _secure; }
78 void dumpProxyStats();
79 void dumpSyncMap(SyncableObject *object);
82 * This method allows to send a signal only to a limited set of peers
83 * @param peerIds A list of peers that should receive it
84 * @param closure Code you want to execute within of that restricted environment
86 void restrictTargetPeers(std::initializer_list<Peer *> peerIds, std::function<void()> closure);
88 inline int peerCount() const { return _peers.size(); }
89 QVariantList peerData();
91 Peer *peerById(int peerId);
94 * @return If handling a signal, the Peer from which the current signal originates
96 Peer *sourcePeer() { return _sourcePeer; }
99 void detachObject(QObject *obj);
100 void detachSignals(QObject *sender);
101 void detachSlots(QObject *receiver);
104 void customEvent(QEvent *event);
105 void sync_call__(const SyncableObject *obj, ProxyMode modeType, const char *funcname, va_list ap);
106 void renameObject(const SyncableObject *obj, const QString &newname, const QString &oldname);
109 void removePeerBySender();
110 void objectRenamed(const QByteArray &classname, const QString &newname, const QString &oldname);
111 void updateSecureState();
114 void peerRemoved(Peer *peer);
117 void objectInitialized(SyncableObject *);
118 void heartBeatIntervalChanged(int secs);
119 void maxHeartBeatCountChanged(int max);
120 void lagUpdated(int lag);
121 void secureStateChanged(bool);
125 class PeerMessageEvent;
131 static const QMetaObject *metaObject(const QObject *obj);
133 void removePeer(Peer *peer);
134 void removeAllPeers();
137 return _lastPeerId++;
141 void dispatch(const T &protoMessage);
143 void dispatch(Peer *peer, const T &protoMessage);
145 void handle(Peer *peer, const Protocol::SyncMessage &syncMessage);
146 void handle(Peer *peer, const Protocol::RpcCall &rpcCall);
147 void handle(Peer *peer, const Protocol::InitRequest &initRequest);
148 void handle(Peer *peer, const Protocol::InitData &initData);
151 void handle(Peer *, T) { Q_ASSERT(0); }
153 bool invokeSlot(QObject *receiver, int methodId, const QVariantList ¶ms, QVariant &returnValue, Peer *peer = 0);
154 bool invokeSlot(QObject *receiver, int methodId, const QVariantList ¶ms = QVariantList(), Peer *peer = 0);
156 void requestInit(SyncableObject *obj);
157 QVariantMap initData(SyncableObject *obj) const;
158 void setInitData(SyncableObject *obj, const QVariantMap &properties);
160 static void disconnectDevice(QIODevice *dev, const QString &reason = QString());
163 QHash<int, Peer*> _peerMap;
165 // containg a list of argtypes for fast access
166 QHash<const QMetaObject *, ExtendedMetaObject *> _extendedMetaObjects;
168 // SignalRelay for all manually attached signals
169 SignalRelay *_signalRelay;
171 // RPC function -> (object, slot ID)
172 typedef QPair<QObject *, int> MethodId;
173 typedef QMultiHash<QByteArray, MethodId> SlotHash;
174 SlotHash _attachedSlots;
177 typedef QHash<QString, SyncableObject *> ObjectId;
178 QHash<QByteArray, ObjectId> _syncSlave;
180 ProxyMode _proxyMode;
181 int _heartBeatInterval;
182 int _maxHeartBeatCount;
184 bool _secure; // determines if all connections are in a secured state (using ssl or internal connections)
188 QSet<Peer *> _restrictedTargets;
189 bool _restrictMessageTarget = false;
193 friend class SignalRelay;
194 friend class SyncableObject;
199 // ==================================================
200 // ExtendedMetaObject
201 // ==================================================
202 class SignalProxy::ExtendedMetaObject
204 class MethodDescriptor
207 MethodDescriptor(const QMetaMethod &method);
208 MethodDescriptor() : _returnType(-1), _minArgCount(-1), _receiverMode(SignalProxy::Client) {}
210 inline const QByteArray &methodName() const { return _methodName; }
211 inline const QList<int> &argTypes() const { return _argTypes; }
212 inline int returnType() const { return _returnType; }
213 inline int minArgCount() const { return _minArgCount; }
214 inline SignalProxy::ProxyMode receiverMode() const { return _receiverMode; }
217 QByteArray _methodName;
218 QList<int> _argTypes;
221 SignalProxy::ProxyMode _receiverMode; // Only acceptable as a Sync Call if the receiving SignalProxy is in this mode.
226 ExtendedMetaObject(const QMetaObject *meta, bool checkConflicts);
228 inline const QByteArray &methodName(int methodId) { return methodDescriptor(methodId).methodName(); }
229 inline const QList<int> &argTypes(int methodId) { return methodDescriptor(methodId).argTypes(); }
230 inline int returnType(int methodId) { return methodDescriptor(methodId).returnType(); }
231 inline int minArgCount(int methodId) { return methodDescriptor(methodId).minArgCount(); }
232 inline SignalProxy::ProxyMode receiverMode(int methodId) { return methodDescriptor(methodId).receiverMode(); }
234 inline int methodId(const QByteArray &methodName) { return _methodIds.contains(methodName) ? _methodIds[methodName] : -1; }
236 inline int updatedRemotelyId() { return _updatedRemotelyId; }
238 inline const QHash<QByteArray, int> &slotMap() { return _methodIds; }
239 const QHash<int, int> &receiveMap();
241 const QMetaObject *metaObject() const { return _meta; }
243 static QByteArray methodName(const QMetaMethod &method);
244 static QString methodBaseName(const QMetaMethod &method);
247 const MethodDescriptor &methodDescriptor(int methodId);
249 const QMetaObject *_meta;
250 int _updatedRemotelyId; // id of the updatedRemotely() signal - makes things faster
252 QHash<int, MethodDescriptor> _methods;
253 QHash<QByteArray, int> _methodIds;
254 QHash<int, int> _receiveMap; // if slot x is called then hand over the result to slot y