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
|
/*
* 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_INCLUDE_APPLICATION_MANAGER_RPC_PASSING_HANDLER_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_RPC_PASSING_HANDLER_H_
#include <deque>
#include "application_manager/application.h"
#include "application_manager/commands/command.h"
#include "interfaces/MOBILE_API.h"
#include "smart_objects/smart_object.h"
#include "utils/timer.h"
namespace application_manager {
struct ServiceInfo {
std::string service_id;
uint32_t connection_key;
};
typedef std::shared_ptr<timer::Timer> TimerSPtr;
class AppServiceManager;
class RPCPassingHandler {
public:
RPCPassingHandler(AppServiceManager& asm_ref, ApplicationManager& am_ref);
/**
* @brief Class destructor
*/
~RPCPassingHandler();
/**
* @brief Check if function id is in the handled_rpcs list of an active app
* service
* @param function_id RPC function id
* @return true if function id exists in handled_rpcs list of an active app
* service
*/
bool CanHandleFunctionID(int32_t function_id);
/**
* @brief Check if app services or core is being used to handle the RPC
* @param correlation_id correlation id of RPC response
* @return true if an app service was used to handle the RPC
*/
bool IsPassThroughMessage(uint32_t correlation_id,
commands::Command::CommandSource source,
int32_t message_type);
/**
* @brief Check if passthrough is allowed by policies for a given message
* @param rpc_message RPC message SmartObject
* @return true if the request is allowed to be passed through, false
* otherwise
*/
bool IsPassthroughAllowed(smart_objects::SmartObject rpc_message);
/**
* @brief Function to handle sending and receiving RPC Passing
* requests/responses
* @param rpc_message RPC message SmartObject
* @return true if the request was handled, false otherwise
*/
bool RPCPassThrough(smart_objects::SmartObject rpc_message);
private:
bool PerformNextRequest(uint32_t correlation_id);
void OnPassThroughRequestTimeout();
void AddRequestTimer(uint32_t correlation_id);
void RemoveRequestTimer(uint32_t correlation_id);
void ClearCompletedTimers();
void ForwardRequestToMobile(uint32_t correlation_id);
void ForwardRequestToCore(uint32_t correlation_id);
void ForwardResponseToMobile(uint32_t correlation_id,
smart_objects::SmartObject response_message);
void PopulateRPCRequestQueue(smart_objects::SmartObject request_message);
bool ExtractRPCParams(const smart_objects::SmartObject& s_map,
const ApplicationSharedPtr app,
const std::string& function_id_str);
AppServiceManager& app_service_manager_;
ApplicationManager& app_manager_;
sync_primitives::RecursiveLock rpc_request_queue_lock_;
std::map<uint32_t,
std::pair<smart_objects::SmartObject, std::deque<ServiceInfo> > >
rpc_request_queue;
sync_primitives::RecursiveLock timeout_queue_lock_;
std::vector<std::pair<TimerSPtr, uint32_t> > timeout_queue_;
};
} // namespace application_manager
#endif // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_RPC_PASSING_HANDLER_H_
|
