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
|
/*
* FeatureProviderInterface.h - interface class for feature plugins
*
* Copyright (c) 2017-2019 Tobias Junghans <tobydox@veyon.io>
*
* This file is part of Veyon - http://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.
*
*/
#ifndef FEATURE_PROVIDER_INTERFACE_H
#define FEATURE_PROVIDER_INTERFACE_H
#include "ComputerControlInterface.h"
#include "FeatureMessage.h"
#include "Feature.h"
#include "PluginInterface.h"
class VeyonMasterInterface;
class VeyonServerInterface;
class VeyonWorkerInterface;
// clazy:excludeall=copyable-polymorphic
class VEYON_CORE_EXPORT FeatureProviderInterface
{
public:
/*!
* \brief Returns a list of features implemented by the feature class
*/
virtual const FeatureList& featureList() const = 0;
/*!
* \brief Start a feature on master side for given computer control interfaces
* \param master a reference to a master instance implementing the VeyonMasterInterface
* \param feature the feature to start
* \param computerControlInterfaces a list of ComputerControlInterfaces to operate on
*/
virtual bool startFeature( VeyonMasterInterface& master,
const Feature& feature,
const ComputerControlInterfaceList& computerControlInterfaces ) = 0;
/*!
* \brief Stops a feature on master side for given computer control interfaces
* \param master a reference to a master instance implementing the VeyonMasterInterface
* \param feature the feature to stop
* \param computerControlInterfaces a list of ComputerControlInterfaces to operate on
*/
virtual bool stopFeature( VeyonMasterInterface& master,
const Feature& feature,
const ComputerControlInterfaceList& computerControlInterfaces ) = 0;
/*!
* \brief Handles a received feature message inside master
* \param master a reference to a master instance implementing the VeyonMasterInterface
* \param message the message which has been received and needs to be handled
* \param computerControlInterfaces the interface over which the message has been received
*/
virtual bool handleFeatureMessage( VeyonMasterInterface& master,
const FeatureMessage& message,
ComputerControlInterface::Pointer computerControlInterface ) = 0;
/*!
* \brief Handles a received feature message inside server
* \param server a reference to a server instance implementing the VeyonServerInterface
* \param message the message which has been received and needs to be handled
*/
virtual bool handleFeatureMessage( VeyonServerInterface& server,
const FeatureMessage& message ) = 0;
/*!
* \brief Handles a received feature message inside worker
* \param worker a reference to a worker instance implementing the VeyonWorkerInterface
* \param message the message which has been received and needs to be handled
*/
virtual bool handleFeatureMessage( VeyonWorkerInterface& worker,
const FeatureMessage& message ) = 0;
protected:
bool sendFeatureMessage( const FeatureMessage& message,
const ComputerControlInterfaceList& computerControlInterfaces )
{
for( auto controlInterface : computerControlInterfaces )
{
controlInterface->sendFeatureMessage( message );
}
return true;
}
};
typedef QList<FeatureProviderInterface *> FeatureProviderInterfaceList;
#define FeatureProviderInterface_iid "io.veyon.Veyon.FeatureProviderInterface"
Q_DECLARE_INTERFACE(FeatureProviderInterface, FeatureProviderInterface_iid)
#endif // FEATURE_PROVIDER_INTERFACE_H
|
