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
|
/**
* 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_REQUEST_CONTROLLER_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_REQUEST_CONTROLLER_H_
#include <list>
#include "utils/lock.h"
#include "interfaces/MOBILE_API.h"
#include "request_watchdog/request_watchdog.h"
#include "request_watchdog/watchdog_subscriber.h"
#include "application_manager/commands/command.h"
namespace application_manager {
namespace request_controller {
/*
* @brief RequestController class is used to control currently active mobile
* requests.
*/
class RequestController: public request_watchdog::WatchdogSubscriber {
public:
// Data types
/*
* @brief Typedef for active mobile request
*
*/
typedef utils::SharedPtr<commands::Command> Request;
/**
* @brief Synchronizing state identifiers
*/
enum TResult
{
SUCCESS = 0,
TOO_MANY_REQUESTS,
TOO_MANY_PENDING_REQUESTS,
NONE_HMI_LEVEL_MANY_REQUESTS
};
// Methods
/*
* @brief Class constructor
*
*/
RequestController();
/*
* @brief Class destructor
*
*/
virtual ~RequestController();
/*
* @brief Check if max request amount wasn't exceed and adds request to queue.
*
* @param request Active mobile request
* @param hmi_level Current application hmi_level
*
* @return Result code
*
*/
TResult addRequest(const Request& request,
const mobile_apis::HMILevel::eType& hmi_level);
/*
* @brief Removes request from queue
*
* @param mobile_corellation_id Active mobile request correlation ID
*
*/
void terminateRequest(const uint32_t& mobile_correlation_id);
/*
* @brief Removes all requests from queue for specified application
*
* @param app_id Mobile application ID
*
*/
void terminateAppRequests(const uint32_t& app_id);
/**
* @ Updates request timeout
*
* @param connection_key Connection key of application
* @param mobile_correlation_id Correlation ID of the mobile request
* @param new_timeout_value New timeout to be set
*/
void updateRequestTimeout(const uint32_t& connection_key,
const uint32_t& mobile_correlation_id,
const uint32_t& new_timeout);
/*
* @brief Notify subscriber that expired entry should be removed
* using Watchdog::removeRequest(int32_t connection_key, int32_t correlation_id)
*
* @param RequestInfo Request related information
*/
void onTimeoutExpired(const request_watchdog::RequestInfo& info);
protected:
private:
std::list<Request> request_list_;
sync_primitives::Lock request_list_lock_;
request_watchdog::Watchdog* watchdog_;
DISALLOW_COPY_AND_ASSIGN(RequestController);
};
} // namespace request_controller
} // namespace application_manager
#endif // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_REQUEST_CONTROLLER_H_
|
