kdeconnect-kde/core/networkpackage.h
Aleix Pol f9406e8afc Introduce QVariantMap as an argument of NetworkPackage
Makes it possible to specify the different properties sent at once,
rather than one by one as we used to do.

Also port whenever possible to the initializer-list syntax.

REVIEW: 128269
2016-06-21 20:07:12 +02:00

105 lines
4 KiB
C++

/**
* Copyright 2013 Albert Vaca <albertvaka@gmail.com>
*
* 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) version 3 or any later version
* accepted by the membership of KDE e.V. (or its successor approved
* by the membership of KDE e.V.), which shall act as a proxy
* defined in Section 14 of version 3 of the license.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef NETWORKPACKAGE_H
#define NETWORKPACKAGE_H
#include "networkpackagetypes.h"
#include <QObject>
#include <QString>
#include <QVariant>
#include <QIODevice>
//#include <QtCrypto>
#include <QSharedPointer>
#include <QUrl>
#include "kdeconnectcore_export.h"
class FileTransferJob;
class KDECONNECTCORE_EXPORT NetworkPackage
{
Q_GADGET
Q_PROPERTY( QString id READ id WRITE setId )
Q_PROPERTY( QString type READ type WRITE setType )
Q_PROPERTY( QVariantMap body READ body WRITE setBody )
Q_PROPERTY( QVariantMap payloadTransferInfo READ payloadTransferInfo WRITE setPayloadTransferInfo )
Q_PROPERTY( qint64 payloadSize READ payloadSize WRITE setPayloadSize )
public:
//const static QCA::EncryptionAlgorithm EncryptionAlgorithm;
const static int ProtocolVersion;
explicit NetworkPackage(const QString& type, const QVariantMap &body = {});
static void createIdentityPackage(NetworkPackage*);
QByteArray serialize() const;
static bool unserialize(const QByteArray& json, NetworkPackage* out);
//void encrypt(QCA::PublicKey& key);
//bool decrypt(QCA::PrivateKey& key, NetworkPackage* out) const;
//bool isEncrypted() const { return mType == PACKAGE_TYPE_ENCRYPTED; }
const QString& id() const { return mId; }
const QString& type() const { return mType; }
QVariantMap& body() { return mBody; }
const QVariantMap& body() const { return mBody; }
//Get and set info from body. Note that id and type can not be accessed through these.
template<typename T> T get(const QString& key, const T& defaultValue = {}) const {
return mBody.value(key,defaultValue).template value<T>(); //Important note: Awesome template syntax is awesome
}
template<typename T> void set(const QString& key, const T& value) { mBody[key] = QVariant(value); }
bool has(const QString& key) const { return mBody.contains(key); }
QSharedPointer<QIODevice> payload() const { return mPayload; }
void setPayload(const QSharedPointer<QIODevice>& device, qint64 payloadSize) { mPayload = device; mPayloadSize = payloadSize; Q_ASSERT(mPayloadSize >= -1); }
bool hasPayload() const { return (mPayloadSize != 0); }
qint64 payloadSize() const { return mPayloadSize; } //-1 means it is an endless stream
FileTransferJob* createPayloadTransferJob(const QUrl &destination) const;
//To be called by a particular DeviceLink
QVariantMap payloadTransferInfo() const { return mPayloadTransferInfo; }
void setPayloadTransferInfo(const QVariantMap& map) { mPayloadTransferInfo = map; }
bool hasPayloadTransferInfo() const { return !mPayloadTransferInfo.isEmpty(); }
private:
void setId(const QString& id) { mId = id; }
void setType(const QString& t) { mType = t; }
void setBody(const QVariantMap& b) { mBody = b; }
void setPayloadSize(qint64 s) { mPayloadSize = s; }
QString mId;
QString mType;
QVariantMap mBody;
QSharedPointer<QIODevice> mPayload;
qint64 mPayloadSize;
QVariantMap mPayloadTransferInfo;
};
KDECONNECTCORE_EXPORT QDebug operator<<(QDebug s, const NetworkPackage& pkg);
#endif // NETWORKPACKAGE_H