SignalProxy takes now owner ship of passed iodevices if the don't have a parent.
[quassel.git] / src / common / signalproxy.h
index be2c9ff..e628897 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-07 by the Quassel IRC Team                         *
+ *   Copyright (C) 2005-08 by the Quassel Project                          *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -18,8 +18,8 @@
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
 
-#ifndef _SIGNALPROXY_H_
-#define _SIGNALPROXY_H_
+#ifndef SIGNALPROXY_H
+#define SIGNALPROXY_H
 
 #include <QList>
 #include <QHash>
 #include <QPair>
 #include <QString>
 #include <QByteArray>
+#include <QTimer>
 
 class SignalRelay;
-class QMetaObject;
+class SyncableObject;
+struct QMetaObject;
 
 class SignalProxy : public QObject {
   Q_OBJECT
 
+  class AbstractPeer;
+  class IODevicePeer;
+
 public:
   enum ProxyMode {
     Server,
@@ -42,9 +47,17 @@ public:
   };
 
   enum RequestType {
-    Sync = 0,
+    Sync = 1,
+    RpcCall,
     InitRequest,
-    InitData
+    InitData,
+    HeartBeat,
+    HeartBeatReply
+  };
+
+  enum ClientConnectionType {
+    SignalProxyConnection,
+    IODeviceConnection
   };
 
   SignalProxy(QObject *parent);
@@ -53,98 +66,173 @@ public:
   virtual ~SignalProxy();
 
   void setProxyMode(ProxyMode mode);
-  ProxyMode proxyMode() const;
+  inline ProxyMode proxyMode() const { return _proxyMode; }
 
   bool addPeer(QIODevice *iodev);
-  void removePeer(QIODevice *iodev = 0);
-
+  bool addPeer(SignalProxy *proxy);
+  void removePeer(QObject *peer);
+  void removeAllPeers();
+  
   bool attachSignal(QObject *sender, const char *signal, const QByteArray& sigName = QByteArray());
   bool attachSlot(const QByteArray& sigName, QObject *recv, const char *slot);
 
-  void synchronize(QObject *obj);
-  void synchronizeAsMaster(QObject *obj);
-  void synchronizeAsSlave(QObject *obj);
+  void synchronize(SyncableObject *obj);
+
+//   void setInitialized(SyncableObject *obj);
+//   bool isInitialized(SyncableObject *obj) const;
+  void requestInit(SyncableObject *obj);
 
-  void setInitialized(QObject *obj);
-  bool initialized(QObject *obj);
-  void requestInit(QObject *obj);
-  
   void detachObject(QObject *obj);
   void detachSignals(QObject *sender);
   void detachSlots(QObject *receiver);
+  void stopSync(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);
+  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);
+  static bool readDataFromDevice(QIODevice *dev, quint32 &blockSize, QVariant &item, bool compressed = false);
 
   static QString methodBaseName(const QMetaMethod &method);
-  
+
   const QList<int> &argTypes(QObject *obj, int methodId);
+  const int &returnType(QObject *obj, int methodId);
+  const int &minArgCount(QObject *obj, int methodId);
   const QByteArray &methodName(QObject *obj, int methodId);
-  const QHash<int, int> &syncMap(QObject *obj);
+  const QHash<QByteArray, int> &syncMap(SyncableObject *obj);
+  const QHash<int, int> &receiveMap(SyncableObject *obj);
+  int updatedRemotelyId(SyncableObject *obj);
 
   typedef QHash<int, QList<int> > ArgHash;
   typedef QHash<int, QByteArray> MethodNameHash;
   struct ClassInfo {
     ArgHash argTypes;
+    QHash<int, int> returnType;
+    QHash<int, int> minArgCount;
     MethodNameHash methodNames;
-    QHash<int, int> syncMap;
+    int updatedRemotelyId; // id of the updatedRemotely() signal - makes things faster
+    QHash<QByteArray, int> syncMap;
+    QHash<int, int> receiveMap;
   };
 
   void dumpProxyStats();
   
+protected:
+  void customEvent(QEvent *event);
+
 private slots:
   void dataAvailable();
   void detachSender();
   void removePeerBySender();
-  void objectRenamed(QString oldname, QString newname);
-  void objectRenamed(QByteArray classname, QString oldname, QString newname);
-
+  void objectRenamed(const QString &newname, const QString &oldname);
+  void objectRenamed(const QByteArray &classname, const QString &newname, const QString &oldname);
+  void sendHeartBeat();
+  void receiveHeartBeat(AbstractPeer *peer, const QVariantList &params);
+  void receiveHeartBeatReply(AbstractPeer *peer, const QVariantList &params);
+  
 signals:
-  void peerRemoved(QIODevice *obj);
+  void peerRemoved(QIODevice *dev);
   void connected();
   void disconnected();
+  void objectInitialized(SyncableObject *);
+  void lagUpdated(int lag);
   
 private:
+  void init();
   void initServer();
   void initClient();
   
+  const QMetaObject *metaObject(QObject *obj);
   void createClassInfo(QObject *obj);
   void setArgTypes(QObject *obj, int methodId);
+  void setReturnType(QObject *obj, int methodId);
+  void setMinArgCount(QObject *obj, int methodId);
   void setMethodName(QObject *obj, int methodId);
-  void setSyncMap(QObject *obj);
+  void setSyncMap(SyncableObject *obj);
+  void setReceiveMap(SyncableObject *obj);
+  void setUpdatedRemotelyId(SyncableObject *obj);
 
   bool methodsMatch(const QMetaMethod &signal, const QMetaMethod &slot) const;
 
-  void dispatchSignal(QIODevice *receiver, const QVariant &identifier, const QVariantList &params);
-  void dispatchSignal(const QVariant &identifier, const QVariantList &params);
-  
-  void receivePeerSignal(QIODevice *sender, const QVariant &packedFunc);
-  void handleSync(QVariantList params);
-  void handleInitRequest(QIODevice *sender, const QVariantList &params);
-  void handleInitData(QIODevice *sender, const QVariantList &params);
-  void handleSignal(const QByteArray &funcName, const QVariantList &params);
+  void dispatchSignal(QIODevice *receiver, const RequestType &requestType, const QVariantList &params);
+  void dispatchSignal(const RequestType &requestType, const QVariantList &params);
+
+  void receivePackedFunc(AbstractPeer *sender, const QVariant &packedFunc);
+  void receivePeerSignal(AbstractPeer *sender, const RequestType &requestType, const QVariantList &params);
+  void receivePeerSignal(SignalProxy *sender, const RequestType &requestType, const QVariantList &params);
+  void handleSync(AbstractPeer *sender, QVariantList params);
+  void handleInitRequest(AbstractPeer *sender, const QVariantList &params);
+  void handleInitData(AbstractPeer *sender, const QVariantList &params);
+  void handleSignal(const QVariantList &data);
 
-  bool invokeSlot(QObject *receiver, int methodId, const QVariantList &params);
+  bool invokeSlot(QObject *receiver, int methodId, const QVariantList &params, QVariant &returnValue);
+  bool invokeSlot(QObject *receiver, int methodId, const QVariantList &params = QVariantList());
 
-  QVariantMap initData(QObject *obj) const;
-  void setInitData(QObject *obj, const QVariantMap &properties);
-  bool setInitValue(QObject *obj, const QString &property, const QVariant &value);
+  QVariantMap initData(SyncableObject *obj) const;
+  void setInitData(SyncableObject *obj, const QVariantMap &properties);
 
-  void _detachSignals(QObject *sender);
-  void _detachSlots(QObject *receiver);
+  void updateLag(IODevicePeer *peer, int lag);
 
-    void dumpSyncMap(QObject *object);
+public:
+  void dumpSyncMap(SyncableObject *object);
+  inline int peerCount() const { return _peers.size(); }
   
+private:
+  class 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 &params) = 0;
+  private:
+    PeerType _type;
+  };
+
+  class IODevicePeer : public 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 &params);
+    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 SignalProxyPeer : public AbstractPeer {
+  public:
+    SignalProxyPeer(SignalProxy *sender, SignalProxy *receiver) : AbstractPeer(AbstractPeer::SignalProxyPeer), sender(sender), receiver(receiver) {}
+    virtual void dispatchSignal(const RequestType &requestType, const QVariantList &params);
+  private:
+    SignalProxy *sender;
+    SignalProxy *receiver;
+  };
+
+  // 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;
+
   // containg a list of argtypes for fast access
   QHash<const QMetaObject *, ClassInfo*> _classInfo;
 
@@ -157,13 +245,12 @@ private:
   SlotHash _attachedSlots;
 
   // slaves for sync
-  typedef QHash<QString, QObject *> ObjectId;
+  typedef QHash<QString, SyncableObject *> ObjectId;
   QHash<QByteArray, ObjectId> _syncSlave;
 
-  // Hash of used QIODevices
-  QHash<QIODevice*, quint32> _peerByteCount;
 
   ProxyMode _proxyMode;
+  QTimer _heartBeatTimer;
   
   friend class SignalRelay;
 };