src/common/protocol.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2013 by the Quassel Project                        *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   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.                                           *
   9  *                                                                         *
  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.                          *
  14  *                                                                         *
  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  ***************************************************************************/
  20
  21 #ifndef PROTOCOL_H_
  22 #define PROTOCOL_H_
  23
  24 #include <QByteArray>
  25 #include <QDateTime>
  26 #include <QVariantList>
  27
  28 namespace Protocol {
  29
  30 enum Handler {
  31     SignalProxy
  32 };
  33
  34
  35 /*** handled by SignalProxy ***/
  36
  37 class SyncMessage
  38 {
  39 public:
  40     inline SyncMessage(const QByteArray &className, const QString &objectName, const QByteArray &slotName, const QVariantList &params)
  41     : _className(className), _objectName(objectName), _slotName(slotName), _params(params) {}
  42
  43     inline Handler handler() const { return SignalProxy; }
  44
  45     inline QByteArray className() const { return _className; }
  46     inline QString objectName() const { return _objectName; }
  47     inline QByteArray slotName() const { return _slotName; }
  48
  49     inline QVariantList params() const { return _params; }
  50
  51 private:
  52     QByteArray _className;
  53     QString _objectName;
  54     QByteArray _slotName;
  55     QVariantList _params;
  56 };
  57
  58
  59 class RpcCall
  60 {
  61 public:
  62     inline RpcCall(const QByteArray &slotName, const QVariantList &params)
  63     : _slotName(slotName), _params(params) {}
  64
  65     inline Handler handler() const { return SignalProxy; }
  66
  67     inline QByteArray slotName() const { return _slotName; }
  68     inline QVariantList params() const { return _params; }
  69
  70 private:
  71     QByteArray _slotName;
  72     QVariantList _params;
  73 };
  74
  75
  76 class InitRequest
  77 {
  78 public:
  79     inline InitRequest(const QByteArray &className, const QString &objectName)
  80     : _className(className), _objectName(objectName) {}
  81
  82     inline Handler handler() const { return SignalProxy; }
  83
  84     inline QByteArray className() const { return _className; }
  85     inline QString objectName() const { return _objectName; }
  86
  87 private:
  88     QByteArray _className;
  89     QString _objectName;
  90 };
  91
  92
  93 class InitData
  94 {
  95 public:
  96     inline InitData(const QByteArray &className, const QString &objectName, const QVariantMap &initData)
  97     : _className(className), _objectName(objectName), _initData(initData) {}
  98
  99     inline Handler handler() const { return SignalProxy; }
 100
 101     inline QByteArray className() const { return _className; }
 102     inline QString objectName() const { return _objectName; }
 103
 104     inline QVariantMap initData() const { return _initData; }
 105
 106 private:
 107     QByteArray _className;
 108     QString _objectName;
 109     QVariantMap _initData;
 110 };
 111
 112
 113 /*** handled by RemoteConnection ***/
 114
 115 class HeartBeat
 116 {
 117 public:
 118     inline HeartBeat(const QDateTime &timestamp) : _timestamp(timestamp) {}
 119
 120     inline QDateTime timestamp() const { return _timestamp; }
 121
 122 private:
 123     QDateTime _timestamp;
 124 };
 125
 126
 127 class HeartBeatReply
 128 {
 129 public:
 130     inline HeartBeatReply(const QDateTime &timestamp) : _timestamp(timestamp) {}
 131
 132     inline QDateTime timestamp() const { return _timestamp; }
 133
 134 private:
 135     QDateTime _timestamp;
 136 };
 137
 138
 139 };
 140
 141 #endif