summaryrefslogtreecommitdiff
path: root/src/components/remote_control/include/remote_control/remote_control_plugin.h
blob: 9875723f43f4c6b543573b11ed5aed201a0b6d64 (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
/*
 * Copyright (c) 2013, 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_REMOTE_CONTROL_INCLUDE_REMOTE_CONTROL_REMOTE_CONTROL_PLUGIN_H_
#define SRC_COMPONENTS_REMOTE_CONTROL_INCLUDE_REMOTE_CONTROL_REMOTE_CONTROL_PLUGIN_H_

#include <queue>
#include <string>

#include "remote_control/remote_plugin_interface.h"
#include "functional_module/generic_module.h"
#include "remote_control/request_controller.h"
#include "utils/threads/message_loop_thread.h"
#include "remote_control/event_engine/event_dispatcher.h"
#include "remote_control/resource_allocation_manager_impl.h"

namespace remote_control {
typedef rc_event_engine::EventDispatcher<application_manager::MessagePtr,
                                         std::string> RCEventDispatcher;

class RemoteControlPlugin : public RemotePluginInterface {
 public:
  RemoteControlPlugin();
  ~RemoteControlPlugin();

  functional_modules::PluginInfo GetPluginInfo() const;
  virtual functional_modules::ProcessResult ProcessMessage(
      application_manager::MessagePtr msg);
  virtual functional_modules::ProcessResult ProcessHMIMessage(
      application_manager::MessagePtr msg);

  /**
   * @brief Sends response to mobile application
   * @param msg response mesage
   */
  void SendResponseToMobile(application_manager::MessagePtr msg);

  /**
   * @brief Sends timeout response to mobile application
   * @param msg response mesage
   */
  void SendTimeoutResponseToMobile(application_manager::MessagePtr msg);

  /**
   * @brief Remove extension created for specified application
   * @param app_id application id
   */
  virtual void RemoveAppExtension(uint32_t app_id);

  /**
   * @brief Check registering app can be handled by plugin
   * @param msg Registration message
   * @param app Application basis already create by Core
   */
  bool IsAppForPlugin(application_manager::ApplicationSharedPtr app);

  /**
   * @brief Notify about change of HMILevel of plugin's app
   * @param app App with new HMILevel
   * @param old_level Old HMILevel of app
   */
  void OnAppHMILevelChanged(application_manager::ApplicationSharedPtr app,
                            mobile_apis::HMILevel::eType old_level);

  /**
   * @brief Checks if plugin hasn't put restrictions on app's HMI Level
   * @param app App with old HMILevel
   * @param new_level HMILevel which is about to be set to app
   */
  virtual bool CanAppChangeHMILevel(
      application_manager::ApplicationSharedPtr app,
      mobile_apis::HMILevel::eType new_level);

  /**
   * Handles removing (disconnecting) device
   * @param device removed
   */
  void OnDeviceRemoved(const connection_handler::DeviceHandle& device) OVERRIDE;

  /**
   * @brief OnUnregisterApplication handles application unregistering event
   * @param app_id application id which was unregistered
   */
  void OnUnregisterApplication(const uint32_t app_id) OVERRIDE;

  void SendHmiStatusNotification(
      application_manager::ApplicationSharedPtr app) OVERRIDE;

  RCEventDispatcher& event_dispatcher() OVERRIDE;

  ResourceAllocationManager& resource_allocation_manager() OVERRIDE;

 protected:
  /**
   * @brief Remove extension for all applications
   */
  virtual void RemoveAppExtensions() OVERRIDE;

 private:
  void SubscribeOnFunctions();
  void NotifyMobiles(application_manager::MessagePtr msg);

  functional_modules::ProcessResult HandleMessage(
      application_manager::MessagePtr msg);

  functional_modules::PluginInfo plugin_info_;
  bool is_scan_started_;
  request_controller::RequestController request_controller_;

  RCEventDispatcher event_dispatcher_;

  ResourceAllocationManagerImpl resource_allocation_manager_;
  DISALLOW_COPY_AND_ASSIGN(RemoteControlPlugin);
};

}  // namespace remote_control

#endif  // SRC_COMPONENTS_REMOTE_CONTROL_INCLUDE_REMOTE_CONTROL_REMOTE_CONTROL_PLUGIN_H_