1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
|
/*
* FeatureMessage.h - header for a message encapsulation class for features
*
* Copyright (c) 2017-2021 Tobias Junghans <tobydox@veyon.io>
*
* This file is part of Veyon - https://veyon.io
*
* 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.
*
* 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 (see COPYING); if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*
*/
#pragma once
#include <QVariant>
#include "Feature.h"
#include "MessageContext.h"
class QIODevice;
class VEYON_CORE_EXPORT FeatureMessage
{
public:
using MessageSize = quint32;
using FeatureUid = Feature::Uid;
using Command = qint32;
using Arguments = QVariantMap;
static constexpr unsigned char RfbMessageType = 41;
enum SpecialCommands
{
DefaultCommand = 0,
InvalidCommand = -1,
InitCommand = -2,
};
explicit FeatureMessage() :
m_featureUid(),
m_command( InvalidCommand ),
m_arguments()
{
}
explicit FeatureMessage( FeatureUid featureUid, Command command ) :
m_featureUid( featureUid ),
m_command( command ),
m_arguments()
{
}
explicit FeatureMessage( const FeatureMessage& other ) :
m_featureUid( other.featureUid() ),
m_command( other.command() ),
m_arguments( other.arguments() )
{
}
~FeatureMessage() = default;
FeatureMessage& operator=( const FeatureMessage& other )
{
m_featureUid = other.featureUid();
m_command = other.command();
m_arguments = other.arguments();
return *this;
}
const FeatureUid& featureUid() const
{
return m_featureUid;
}
Command command() const
{
return m_command;
}
const Arguments& arguments() const
{
return m_arguments;
}
template<typename T = int>
FeatureMessage& addArgument( T index, const QVariant& value )
{
m_arguments[QString::number( static_cast<int>( index ) )] = value;
return *this;
}
template<typename T = int>
QVariant argument( T index ) const
{
return m_arguments[QString::number( static_cast<int>( index ) )];
}
template<typename T = int>
bool hasArgument( T index ) const
{
return m_arguments.contains( QString::number( static_cast<int>( index ) ) );
}
bool send( QIODevice* ioDevice ) const;
bool isReadyForReceive( QIODevice* ioDevice );
bool receive( QIODevice* ioDevice );
private:
FeatureUid m_featureUid;
Command m_command;
Arguments m_arguments;
} ;
|