summaryrefslogtreecommitdiff
path: root/src/components/application_manager/rpc_plugins/rc_rpc_plugin/include/rc_rpc_plugin/rc_rpc_plugin.h
blob: e45d48d63a8a7e87cb303b1a6e61afb5074ccef2 (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
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
/*
 Copyright (c) 2018, Ford Motor Company
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

 Redistributions of source code must retain the above copyright notice, this
 list of conditions and the following disclaimer.

 Redistributions in binary form must reproduce the above copyright notice,
 this list of conditions and the following
 disclaimer in the documentation and/or other materials provided with the
 distribution.

 Neither the name of the Ford Motor Company nor the names of its contributors
 may be used to endorse or promote products derived from this software
 without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef SRC_COMPONENTS_APPLICATION_MANAGER_RPC_PLUGINS_RC_RPC_PLUGIN_INCLUDE_RC_RPC_PLUGIN_RC_RPC_PLUGIN_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_RPC_PLUGINS_RC_RPC_PLUGIN_INCLUDE_RC_RPC_PLUGIN_RC_RPC_PLUGIN_H_

#include <memory>

#include "application_manager/command_factory.h"
#include "application_manager/plugin_manager/rpc_plugin.h"
#include "application_manager/resumption/pending_resumption_handler.h"
#include "rc_rpc_plugin/interior_data_cache.h"
#include "rc_rpc_plugin/interior_data_manager.h"
#include "rc_rpc_plugin/rc_capabilities_manager.h"
#include "rc_rpc_plugin/rc_consent_manager.h"
#include "rc_rpc_plugin/resource_allocation_manager.h"
#include "utils/ilogger.h"

namespace rc_rpc_plugin {
namespace plugins = application_manager::plugin_manager;
namespace app_mngr = application_manager;

class RCRPCPlugin : public plugins::RPCPlugin {
 public:
  /**
   * @brief Command initialization function
   * @param app_manager ApplicationManager
   * @param rpc_service RPCService
   * @param hmi_capabilities HMICapabilities
   * @param policy_handler PolicyHandlerInterface
   * @return true in case initialization was succesful, false otherwise.
   **/
  bool Init(app_mngr::ApplicationManager& app_manager,
            app_mngr::rpc_service::RPCService& rpc_service,
            app_mngr::HMICapabilities& hmi_capabilities,
            policy::PolicyHandlerInterface& policy_handler,
            resumption::LastStateWrapperPtr last_state) OVERRIDE;

  /**
   * @param int32_t command id
   * @param CommandSource source
   * @return return true if command can be create, else return false
   **/
  bool IsAbleToProcess(
      const int32_t function_id,
      const app_mngr::commands::Command::CommandSource message_source) OVERRIDE;
  /**
   * @brief PluginName plugin name
   * @return plugin name
   */
  std::string PluginName() OVERRIDE;
  /**
   * @brief GetCommandFactory get that is able to generate command
   * from message
   * @return plugins command factory
   */
  app_mngr::CommandFactory& GetCommandFactory() OVERRIDE;

  /**
   * @brief OnPolicyEvent Processes policy related events
   * @param event Policy event
   */
  void OnPolicyEvent(app_mngr::plugin_manager::PolicyEvent event) OVERRIDE;
  /**
   * @brief OnApplicationEvent Notifies modules on certain application events
   * @param event Event
   * @param application Pointer to application struct
   */
  void OnApplicationEvent(plugins::ApplicationEvent event,
                          app_mngr::ApplicationSharedPtr application) OVERRIDE;

  /**
   * @brief ProcessResumptionSubscription send Subscribe vehicle data requests
   * to HMI
   * @param app application for subscription
   * @param ext application extension
   */
  void ProcessResumptionSubscription(app_mngr::Application& app,
                                     RCAppExtension& ext);

  /**
   * @brief Reverts resumption data, clears all pending resumption and sends
   * unsubscribe interior vehicle data requests to HMI
   * @param subscriptions Module data that SDL should unsubscribe off
   */
  void RevertResumption(const std::set<ModuleUid>& subscriptions);

  /**
   * @brief IsOtherAppsSubscribed check if any app except passed is subscribed
   * to a given module
   * @param module module to check
   * @param app_id app to ignore subscription
   * @return true if any app except passed is subscribed to module, otherwise
   * false
   */
  bool IsOtherAppsSubscribed(const rc_rpc_types::ModuleUid& module,
                             const uint32_t app_id);

  /**
   * @brief Creates the RC extension for specified application
   * @param application pointer to app to work with
   */
  void CreateRcExtension(application_manager::ApplicationSharedPtr application);

  /**
   * @brief Removes the RC extensions for specified application
   * @param application pointer to app to work with
   */
  void RemoveRcExtension(application_manager::ApplicationSharedPtr application);

  typedef std::vector<application_manager::ApplicationSharedPtr> Apps;
  static Apps GetRCApplications(
      application_manager::ApplicationManager& app_mngr);

 private:
  application_manager::rpc_service::RPCService* rpc_service_;
  application_manager::ApplicationManager* app_mngr_;
  std::unique_ptr<rc_rpc_plugin::RCConsentManager> rc_consent_manager_;
  std::unique_ptr<application_manager::CommandFactory> command_factory_;
  std::unique_ptr<ResourceAllocationManager> resource_allocation_manager_;
  std::unique_ptr<InteriorDataCache> interior_data_cache_;
  std::unique_ptr<InteriorDataManager> interior_data_manager_;
  std::unique_ptr<RCCapabilitiesManager> rc_capabilities_manager_;
  using PendingResumptionHandlerSPtr =
      std::shared_ptr<resumption::PendingResumptionHandler>;
  PendingResumptionHandlerSPtr pending_resumption_handler_;
};
}  // namespace rc_rpc_plugin

extern "C" application_manager::plugin_manager::RPCPlugin* Create(
    logger::Logger* logger_instance);
extern "C" void Delete(application_manager::plugin_manager::RPCPlugin* data);

#endif  // SRC_COMPONENTS_APPLICATION_MANAGER_RPC_PLUGINS_RC_RPC_PLUGIN_INCLUDE_RC_RPC_PLUGIN_RC_RPC_PLUGIN_H_