Make the PeerPtr trick work with sync calls as well
[quassel.git] / src / common / signalproxy.h
index f44db23..9297ae8 100644 (file)
@@ -1,11 +1,11 @@
 /***************************************************************************
- *   Copyright (C) 2005-07 by The Quassel IRC Development Team             *
+ *   Copyright (C) 2005-2013 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
+ *   (at your option) version 3.                                           *
  *                                                                         *
  *   This program is distributed in the hope that it will be useful,       *
  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  *   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 _RPCPEER_H_
-#define _RPCPEER_H_
+#ifndef SIGNALPROXY_H
+#define SIGNALPROXY_H
 
-#include <QtCore>
+#include <QEvent>
+#include <QSet>
 
-class QxtRPCPeer;
+#include "protocol.h"
 
-class SignalProxy : public QObject {
-  Q_OBJECT
+struct QMetaObject;
 
-  public:
+class Peer;
+class SyncableObject;
 
-    enum ProxyType { Client, Server };
+class SignalProxy : public QObject
+{
+    Q_OBJECT
 
-    SignalProxy(ProxyType type, QIODevice *device = 0, QObject *parent = 0);
-    ~SignalProxy();
+    class SignalRelay;
 
-  ProxyType proxyType() const { return type; }
-    void attachSignal(QObject* sender, const char* signal, const QByteArray& rpcFunction = QByteArray());
-    void attachSlot(const QByteArray& rpcFunction, QObject* recv, const char* slot);
+public:
+    enum ProxyMode {
+        Server,
+        Client
+    };
 
-  public slots:
-    void addPeer(QIODevice *device);
+    enum EventType {
+        RemovePeerEvent = QEvent::User
+    };
 
-    void sendSignal(const char *signal, QVariant p1 = QVariant(), QVariant p2 = QVariant(), QVariant p3 = QVariant(), QVariant p4 = QVariant(),
-              QVariant p5 = QVariant(), QVariant p6 = QVariant(), QVariant p7 = QVariant(), QVariant p8 = QVariant(), QVariant p9 = QVariant());
-  
-    //void detachSender();
-    void detachObject(QObject *);
+    SignalProxy(QObject *parent);
+    SignalProxy(ProxyMode mode, QObject *parent);
+    virtual ~SignalProxy();
 
-  signals:
-    void peerDisconnected();
+    void setProxyMode(ProxyMode mode);
+    inline ProxyMode proxyMode() const { return _proxyMode; }
 
-  private slots:
-    void socketDisconnected();
+    void setHeartBeatInterval(int secs);
+    inline int heartBeatInterval() const { return _heartBeatInterval; }
+    void setMaxHeartBeatCount(int max);
+    inline int maxHeartBeatCount() const { return _maxHeartBeatCount; }
 
-  private:
-    struct Connection {
-      QPointer<QxtRPCPeer> peer;
-      QPointer<QIODevice> device;
-    };
+    bool addPeer(Peer *peer);
 
-    struct SignalDesc {
-      QObject *sender;
-      QByteArray signal;
-      QByteArray rpcFunction;
+    bool attachSignal(QObject *sender, const char *signal, const QByteArray &sigName = QByteArray());
+    bool attachSlot(const QByteArray &sigName, QObject *recv, const char *slot);
 
-      SignalDesc(QObject *sndr, const char *sig, const QByteArray &func) : sender(sndr), signal(sig), rpcFunction(func) {}
-    };
+    void synchronize(SyncableObject *obj);
+    void stopSynchronize(SyncableObject *obj);
 
-    struct SlotDesc {
-      QByteArray rpcFunction;
-      QObject *recv;
-      QByteArray slot;
+    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); }
 
-      SlotDesc(const QByteArray& func, QObject* r, const char* s) : rpcFunction(func), recv(r), slot(s) {}
-    };
+    bool isSecure() const { return _secure; }
+    void dumpProxyStats();
+    void dumpSyncMap(SyncableObject *object);
+    inline int peerCount() const { return _peers.size(); }
+
+public slots:
+    void detachObject(QObject *obj);
+    void detachSignals(QObject *sender);
+    void detachSlots(QObject *receiver);
+
+protected:
+    void customEvent(QEvent *event);
+    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 removePeerBySender();
+    void objectRenamed(const QByteArray &classname, const QString &newname, const QString &oldname);
+    void updateSecureState();
+
+signals:
+    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:
+    template<class T>
+    class PeerMessageEvent;
+
+    void init();
+    void initServer();
+    void initClient();
+
+    static const QMetaObject *metaObject(const QObject *obj);
+
+    void removePeer(Peer *peer);
+    void removeAllPeers();
+
+    template<class T>
+    void dispatch(const T &protoMessage);
+    template<class T>
+    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<class T>
+    void handle(Peer *, T) { Q_ASSERT(0); }
+
+    bool invokeSlot(QObject *receiver, int methodId, const QVariantList &params, QVariant &returnValue, Peer *peer = 0);
+    bool invokeSlot(QObject *receiver, int methodId, const QVariantList &params = QVariantList(), Peer *peer = 0);
+
+    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());
 
-    ProxyType type;
-    QList<Connection> peers;
-    QList<SignalDesc> attachedSignals;
-    QList<SlotDesc> attachedSlots;
+    QSet<Peer *> _peers;
 
+    // containg a list of argtypes for fast access
+    QHash<const QMetaObject *, ExtendedMetaObject *> _extendedMetaObjects;
+
+    // SignalRelay for all manually attached signals
+    SignalRelay *_signalRelay;
+
+    // RPC function -> (object, slot ID)
+    typedef QPair<QObject *, int> MethodId;
+    typedef QMultiHash<QByteArray, MethodId> SlotHash;
+    SlotHash _attachedSlots;
+
+    // slaves for sync
+    typedef QHash<QString, SyncableObject *> ObjectId;
+    QHash<QByteArray, ObjectId> _syncSlave;
+
+    ProxyMode _proxyMode;
+    int _heartBeatInterval;
+    int _maxHeartBeatCount;
+
+    bool _secure; // determines if all connections are in a secured state (using ssl or internal connections)
+
+    friend class SignalRelay;
+    friend class SyncableObject;
+    friend class Peer;
 };
 
 
+// ==================================================
+//  ExtendedMetaObject
+// ==================================================
+class SignalProxy::ExtendedMetaObject
+{
+    class MethodDescriptor
+    {
+    public:
+        MethodDescriptor(const QMetaMethod &method);
+        MethodDescriptor() : _returnType(-1), _minArgCount(-1), _receiverMode(SignalProxy::Client) {}
+
+        inline const QByteArray &methodName() const { return _methodName; }
+        inline const QList<int> &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<int> _argTypes;
+        int _returnType;
+        int _minArgCount;
+        SignalProxy::ProxyMode _receiverMode; // Only acceptable as a Sync Call if the receiving SignalProxy is in this mode.
+    };
+
+
+public:
+    ExtendedMetaObject(const QMetaObject *meta, bool checkConflicts);
+
+    inline const QByteArray &methodName(int methodId) { return methodDescriptor(methodId).methodName(); }
+    inline const QList<int> &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(); }
+
+    inline int methodId(const QByteArray &methodName) { return _methodIds.contains(methodName) ? _methodIds[methodName] : -1; }
+
+    inline int updatedRemotelyId() { return _updatedRemotelyId; }
+
+    inline const QHash<QByteArray, int> &slotMap() { return _methodIds; }
+    const QHash<int, int> &receiveMap();
+
+    const QMetaObject *metaObject() const { return _meta; }
+
+    static QByteArray methodName(const QMetaMethod &method);
+    static QString methodBaseName(const QMetaMethod &method);
+
+private:
+    const MethodDescriptor &methodDescriptor(int methodId);
+
+    const QMetaObject *_meta;
+    int _updatedRemotelyId; // id of the updatedRemotely() signal - makes things faster
+
+    QHash<int, MethodDescriptor> _methods;
+    QHash<QByteArray, int> _methodIds;
+    QHash<int, int> _receiveMap; // if slot x is called then hand over the result to slot y
+};
 
 #endif