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
|
/*
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_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMANDS_MOBILE_SUBSCRIBE_VEHICLE_DATA_REQUEST_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMANDS_MOBILE_SUBSCRIBE_VEHICLE_DATA_REQUEST_H_
#include "application_manager/commands/command_request_impl.h"
#include "application_manager/application.h"
#include "utils/macro.h"
namespace application_manager {
namespace commands {
/**
* @brief SubscribeVehicleDataRequest command class
**/
class SubscribeVehicleDataRequest : public CommandRequestImpl {
public:
/**
* @brief SubscribeVehicleDataRequest class constructor
*
* @param message Incoming SmartObject message
**/
SubscribeVehicleDataRequest(const MessageSharedPtr& message,
ApplicationManager& application_manager);
/**
* @brief SubscribeButtonCommandRequest class destructor
**/
~SubscribeVehicleDataRequest();
/**
* @brief Execute command
**/
void Run() FINAL;
/**
* @brief Interface method that is called whenever new event received
*
* @param event The received event
*/
void on_event(const event_engine::Event& event) FINAL;
/**
* @brief Init sets hash update mode for request
*/
bool Init() FINAL;
#ifdef HMI_DBUS_API
private:
struct HmiRequest {
hmi_apis::Common_Result::eType status;
bool complete;
smart_objects::SmartObject value;
const char* str;
hmi_apis::FunctionID::eType func_id;
};
typedef std::vector<HmiRequest> HmiRequests;
HmiRequests hmi_requests_;
#endif // #ifdef HMI_DBUS_API
private:
/**
* @brief Checks, if any app is subscribed for particular VI parameter
* @param param_id VI parameter id
* @return true, if there are registered apps subscribed for VI parameter,
* otherwise - false
*/
bool IsSomeoneSubscribedFor(const uint32_t param_id) const;
/**
* @brief Adds VI parameters being subscribed by another or the same app to
* response with appropriate results
* @param msg_params 'message_params' response section reference
*/
void AddAlreadySubscribedVI(smart_objects::SmartObject& msg_params) const;
/**
* @brief Removes subscription for VI parameters which subsription attempt
* returned an error
* @param app Pointer to application sent subscribe request
* @param msg_params 'message_parameters' response section reference
*/
void UnsubscribeFailedSubscriptions(
ApplicationSharedPtr app,
const smart_objects::SmartObject& msg_params) const;
/**
* @brief Checks if current application and other applications
* were subscribed to VI, prepare data that need to send to mobile app
* or HMI.
* @param app contains application
* @param out_info contains resulting info for sending to mobile app
* @param out_result_code contains result code for sending to mobile app
* @param out_response_params contains parameters that SDL sends to
* mobile application
* @param out_request_params contains parameters that SDL sends to
* HMI
* @param result contains result that SDL sends to mobile app.
*/
void CheckVISubscribtions(ApplicationSharedPtr app,
std::string& out_info,
mobile_apis::Result::eType& out_result_code,
smart_objects::SmartObject& out_response_params,
smart_objects::SmartObject& out_request_params,
bool& out_result);
/**
* @brief VI parameters which had been already subscribed by another apps
* befor particular app subscribed for these parameters
*/
VehicleInfoSubscriptions vi_already_subscribed_by_another_apps_;
/**
* @brief VI parameters which had been subscribed already by particular app
*/
VehicleInfoSubscriptions vi_already_subscribed_by_this_app_;
/**
* @brief VI parameters which wait for subscribe after HMI respond
*/
VehicleInfoSubscriptions vi_waiting_for_subscribe_;
DISALLOW_COPY_AND_ASSIGN(SubscribeVehicleDataRequest);
};
} // namespace commands
} // namespace application_manager
#endif // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMANDS_MOBILE_SUBSCRIBE_VEHICLE_DATA_REQUEST_H_
|
