blob: cee8b111e33679e2d28de1237f0f515aa55ad371 (
plain)
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
|
#ifndef SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_PLUGIN_MANAGER_RPC_PLUGIN_H
#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_PLUGIN_MANAGER_RPC_PLUGIN_H
#include <memory>
#include "utils/macro.h"
#include "application_manager/commands/command.h"
#include "application_manager/application.h"
namespace application_manager {
namespace plugin_manager {
class CommandFactory;
/**
* @brief The PolicyEvent enum defines events related to policy
*/
enum PolicyEvent { kApplicationPolicyUpdated = 0, kApplicationsDisabled };
/**
* @brief The ApplicationEvent enum defines events related to single application
*/
enum ApplicationEvent { kApplicationExit = 0, kApplicationUnregistered };
class RPCPlugin {
public:
// TODO : pass all required components for plugin
virtual bool Init() = 0;
/**
* @brief IsAbleToProcess check if plugin is able to process function
* @param function_id RPC identifier
* @param message_source source of message to process (from HMI from mobile
* ...)
* @return true if plugin is able to process this RPC, false if not
*/
virtual bool IsAbleToProcess(
const int32_t function_id,
const commands::Command::CommandSource message_source) = 0;
/**
* @brief PluginName plugin name
* @return plugin name
*/
virtual std::string PluginName() = 0;
/**
* @brief GetCommandFactory get that is able to generate command
* from message
* @return plugins command factory
*/
virtual CommandFactory& GetCommandFactory() = 0;
/**
* @brief OnPolicyEvent Notifies modules on certain events from policy
* @param event Policy event
*/
virtual void OnPolicyEvent(PolicyEvent event) = 0;
/**
* @brief OnApplicationEvent Processes application related events
* @param event Event
* @param application Pointer to application struct
*/
virtual void OnApplicationEvent(
ApplicationEvent event,
application_manager::ApplicationSharedPtr application) = 0;
};
typedef std::unique_ptr<RPCPlugin> RPCPluginPtr;
} // namespace plugin_manager
} // namespace application_manager
#endif // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_PLUGIN_MANAGER_RPC_PLUGIN_H
|
