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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
|
/*
* \file request_info.h
* \brief request information structure header file.
*
* Copyright (c) 2014, 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_INFO_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_REQUEST_INFO_H_
#include <stdint.h>
#include <set>
#include "application_manager/commands/command_request_impl.h"
#include "commands/hmi/request_to_hmi.h"
#include "utils/date_time.h"
namespace application_manager {
namespace request_controller {
/*
* @brief Typedef for active mobile request
*
*/
typedef utils::SharedPtr<commands::Command> RequestPtr;
struct RequestInfo {
enum RequestType {MobileRequest, HMIRequest};
RequestInfo() {}
virtual ~RequestInfo() {}
RequestInfo(RequestPtr request,
const RequestType requst_type,
const uint64_t timeout_msec)
: request_(request),
timeout_msec_(timeout_msec) {
start_time_ = date_time::DateTime::getCurrentTime();
updateEndTime();
requst_type_ = requst_type;
}
RequestInfo(RequestPtr request, const RequestType requst_type,
const TimevalStruct& start_time, const uint64_t timeout_msec);
void updateEndTime();
void updateTimeOut(const uint64_t& timeout_msec);
bool isExpired();
TimevalStruct start_time() {
return start_time_;
}
void update_start_time(TimevalStruct start_time) {
start_time_ = start_time;
}
uint64_t timeout_msec() {
return timeout_msec_;
}
void set_timeout_msec(uint64_t timeout) {
timeout_msec_ = timeout;
}
TimevalStruct end_time() {
return end_time_;
}
uint32_t app_id() {
return app_id_;
}
mobile_apis::HMILevel::eType hmi_level() {
return hmi_level_;
}
void set_hmi_level(const mobile_apis::HMILevel::eType& level) {
hmi_level_ = level;
}
RequestType requst_type() const {
return requst_type_;
}
uint32_t requestId() {
return correlation_id_;
}
commands::Command* request() {
return request_.get();
}
uint64_t hash();
static uint64_t GenerateHash(uint32_t var1, uint32_t var2);
static uint32_t HmiConnectoinKey;
protected:
RequestPtr request_;
TimevalStruct start_time_;
uint64_t timeout_msec_;
TimevalStruct end_time_;
uint32_t app_id_;
mobile_apis::HMILevel::eType hmi_level_;
RequestType requst_type_;
uint32_t correlation_id_;
};
typedef utils::SharedPtr<RequestInfo> RequestInfoPtr;
struct MobileRequestInfo: public RequestInfo {
MobileRequestInfo(RequestPtr request,
const uint64_t timeout_msec);
MobileRequestInfo(RequestPtr request,
const TimevalStruct& start_time,
const uint64_t timeout_msec);
};
struct HMIRequestInfo: public RequestInfo {
HMIRequestInfo(RequestPtr request, const uint64_t timeout_msec);
HMIRequestInfo(RequestPtr request, const TimevalStruct& start_time,
const uint64_t timeout_msec);
};
// Request info, for searching in request info set by log_n time
// Returns correct hash by app_id and corr_id
struct FakeRequestInfo :public RequestInfo {
FakeRequestInfo(uint32_t app_id, uint32_t correaltion_id);
};
struct RequestInfoTimeComparator {
bool operator() (const RequestInfoPtr lhs,
const RequestInfoPtr rhs) const;
};
struct RequestInfoHashComparator {
bool operator() (const RequestInfoPtr lhs,
const RequestInfoPtr rhs) const;
};
typedef std::set<RequestInfoPtr, RequestInfoTimeComparator> TimeSortedRequestInfoSet;
typedef std::set<RequestInfoPtr, RequestInfoHashComparator> HashSortedRequestInfoSet;
/*
* @brief RequestInfoSet provides uniue requests bu corralation_id and app_id
*
*/
class RequestInfoSet {
public:
/*
* @brief Add requests into colletion by log(n) time
* @param request_info - request to add
* @return false is request with the same app_id and correlation_id exist
*/
bool Add(RequestInfoPtr request_info);
/*
* @brief Find requests int colletion by log(n) time
* @param connection_key - connection_key of request
* @param correlation_id - correlation_id of request
* @return founded request or shared_ptr with NULL
*/
RequestInfoPtr Find(const uint32_t connection_key,
const uint32_t correlation_id);
/*
* @brief Get request with smalest end_time_
* @return founded request or shared_ptr with NULL
*/
RequestInfoPtr Front();
/*
* @brief Get request with smalest end_time_ != 0
* @return founded request or shared_ptr with NULL
*/
RequestInfoPtr FrontWithNotNullTimeout();
/*
* @brief Erase request from colletion by log(n) time
* @param request_info - request to erase
* @return true if Erase succes, otherwise return false
*/
bool RemoveRequest(const RequestInfoPtr request_info);
/*
* @brief Erase request from colletion by connection_key
* @param connection_key - connection_key of requests to erase
* @return count of erased requests
*/
uint32_t RemoveByConnectionKey(uint32_t connection_key);
/*
* @brief Erase all mobile requests from controller
* @return count of erased requests
*/
uint32_t RemoveMobileRequests();
/*
* @return count of requestd in collections
*/
const size_t Size();
/**
* @brief Check if this app is able to add new requests,
* or limits was exceeded
* @param app_id - application id
* @param app_time_scale - time scale (seconds)
* @param max_request_per_time_scale - maximum count of request
* that should be allowed for app_time_scale seconds
* @return True if new request could be added, false otherwise
*/
bool CheckTimeScaleMaxRequest(uint32_t app_id,
uint32_t app_time_scale,
uint32_t max_request_per_time_scale);
/**
* @brief Check if this app is able to add new requests
* in current hmi_level, or limits was exceeded
* @param hmi_level - hmi level
* @param app_id - application id
* @param app_time_scale - time scale (seconds)
* @param max_request_per_time_scale - maximum count of request
* that should be allowed for app_time_scale seconds
* @return True if new request could be added, false otherwise
*/
bool CheckHMILevelTimeScaleMaxRequest(mobile_apis::HMILevel::eType hmi_level,
uint32_t app_id,
uint32_t app_time_scale,
uint32_t max_request_per_time_scale);
private:
/*
* @brief Comparator of connection key for std::find_if function
*/
struct AppIdCompararator {
enum CompareType {Equal, NotEqual};
AppIdCompararator(CompareType compare_type, uint32_t app_id):
app_id_(app_id),
compare_type_(compare_type) {}
bool operator()(const RequestInfoPtr value_compare) const;
private:
uint32_t app_id_;
CompareType compare_type_;
};
bool Erase(const RequestInfoPtr request_info);
/*
* @brief Erase requests from collection if filter allows
* @param filter - filtering predicate
* @return count of erased requests
*/
uint32_t RemoveRequests(const RequestInfoSet::AppIdCompararator& filter);
/*
* @brief Debug function, will raise assert if set sizes are noit equal
*/
inline void CheckSetSizes();
TimeSortedRequestInfoSet time_sorted_pending_requests_;
HashSortedRequestInfoSet hash_sorted_pending_requests_;
// the lock caled this_lock_, since the class represent collection by itself.
sync_primitives::Lock this_lock_;
};
/**
* @brief Structure used in std algorithms to determine amount of request
* during time scale
*/
struct TimeScale {
TimeScale(const TimevalStruct& start,
const TimevalStruct& end,
const uint32_t& app_id)
: start_(start),
end_(end),
app_id_(app_id) {}
bool operator()(RequestInfoPtr setEntry) {
if (!setEntry.valid()) {
return false;
}
if (setEntry->app_id() != app_id_) {
return false;
}
if ((setEntry->start_time() < start_) || (end_ < setEntry->start_time() )) {
return false;
}
return true;
}
private:
TimevalStruct start_;
TimevalStruct end_;
uint32_t app_id_;
};
/**
* @brief Structure used in std algorithms to determine amount of request
* during time scale for application in defined hmi level
*/
struct HMILevelTimeScale {
HMILevelTimeScale(const TimevalStruct& start,
const TimevalStruct& end,
const uint32_t& app_id,
const mobile_apis::HMILevel::eType& hmi_level)
: start_(start),
end_(end),
app_id_(app_id),
hmi_level_(hmi_level) {}
bool operator()(RequestInfoPtr setEntry) {
if (!setEntry.valid()) {
return false;
}
if (setEntry->app_id() != app_id_) {
return false;
}
if (setEntry->hmi_level() != hmi_level_) {
return false;
}
if (date_time::DateTime::getSecs(setEntry->start_time())
< date_time::DateTime::getSecs(start_) ||
date_time::DateTime::getSecs(setEntry->start_time())
> date_time::DateTime::getSecs(end_)) {
return false;
}
return true;
}
private:
TimevalStruct start_;
TimevalStruct end_;
uint32_t app_id_;
mobile_apis::HMILevel::eType hmi_level_;
};
} // namespace request_controller
} // namespace application_manager
#endif // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_REQUEST_INFO_H_
|