Say hello to compression!
[quassel.git] / src / common / signalproxy.h
index 23dbc9f..7ffb73b 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  *
 #include <QPair>
 #include <QString>
 #include <QByteArray>
-
-#include <QMutex>
+#include <QTimer>
 
 class SignalRelay;
-class QMetaObject;
+class SyncableObject;
+struct QMetaObject;
 
 class SignalProxy : public QObject {
   Q_OBJECT
@@ -44,9 +44,11 @@ public:
   };
 
   enum RequestType {
-    Sync = 0,
+    Sync = 1,
+    RpcCall,
     InitRequest,
-    InitData
+    InitData,
+    HeartBeat
   };
 
   SignalProxy(QObject *parent);
@@ -63,42 +65,50 @@ public:
   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 synchronize(SyncableObject *obj);
 
-  void setInitialized(QObject *obj);
-  bool initialized(QObject *obj);
-  void requestInit(QObject *obj);
+  void setInitialized(SyncableObject *obj);
+  bool isInitialized(SyncableObject *obj) const;
+  void requestInit(SyncableObject *obj);
 
   void detachObject(QObject *obj);
   void detachSignals(QObject *sender);
   void detachSlots(QObject *receiver);
-  void stopSync(QObject *obj);
+  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<QByteArray, 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;
+    int updatedRemotelyId; // id of the updatedRemotely() signal - makes things faster
     QHash<QByteArray, int> syncMap;
+    QHash<int, int> receiveMap;
   };
 
   void dumpProxyStats();
@@ -107,48 +117,59 @@ 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();
 
 signals:
   void peerRemoved(QIODevice *obj);
   void connected();
   void disconnected();
+  void objectInitialized(SyncableObject *);
   
 private:
   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 dispatchSignal(QIODevice *receiver, const RequestType &requestType, const QVariantList &params);
+  void dispatchSignal(const RequestType &requestType, const QVariantList &params);
   
   void receivePeerSignal(QIODevice *sender, const QVariant &packedFunc);
-  void handleSync(QVariantList params);
+  void handleSync(QIODevice *sender, QVariantList params);
   void handleInitRequest(QIODevice *sender, const QVariantList &params);
   void handleInitData(QIODevice *sender, const QVariantList &params);
   void handleSignal(const QByteArray &funcName, const QVariantList &params);
 
-  bool invokeSlot(QObject *receiver, int methodId, const QVariantList &params);
-
-  QVariantMap initData(QObject *obj) const;
-  void setInitData(QObject *obj, const QVariantMap &properties);
-  bool setInitValue(QObject *obj, const QString &property, const QVariant &value);
+  bool invokeSlot(QObject *receiver, int methodId, const QVariantList &params, QVariant &returnValue);
+  bool invokeSlot(QObject *receiver, int methodId, const QVariantList &params = QVariantList());
 
-  void _detachSignals(QObject *sender);
-  void _detachSlots(QObject *receiver);
-  void _stopSync(QObject *obj);
+  QVariantMap initData(SyncableObject *obj) const;
+  void setInitData(SyncableObject *obj, const QVariantMap &properties);
 
-  void dumpSyncMap(QObject *object);
+public:
+  void dumpSyncMap(SyncableObject *object);
   
+private:
   // Hash of used QIODevices
-  QHash<QIODevice*, quint32> _peerByteCount;
+  struct peerInfo {
+    quint32 byteCount;
+    bool usesCompression;
+    peerInfo() : byteCount(0), usesCompression(false) {};
+  };
+  //QHash<QIODevice*, peerInfo> _peerByteCount;
+  QHash<QIODevice*, peerInfo> _peers;
 
   // containg a list of argtypes for fast access
   QHash<const QMetaObject *, ClassInfo*> _classInfo;
@@ -162,16 +183,12 @@ private:
   SlotHash _attachedSlots;
 
   // slaves for sync
-  typedef QHash<QString, QObject *> ObjectId;
+  typedef QHash<QString, SyncableObject *> ObjectId;
   QHash<QByteArray, ObjectId> _syncSlave;
 
 
   ProxyMode _proxyMode;
-  
-  // the slaveMutex protects both containers:
-  //  - _syncSlaves for sync and init calls
-  //  - _attachedSlots
-  QMutex slaveMutex;
+  QTimer _heartBeatTimer;
   
   friend class SignalRelay;
 };