summaryrefslogtreecommitdiff
path: root/src/components/application_manager/test/mock/include/application_manager/request_info.h
blob: b1409488fdc938a512f8527bd2c5d7d82def934c (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
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
/**
* \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 "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;
  typedef utils::SharedPtr<commands::CommandRequestImpl> MobileRequestPtr;

  struct RequestInfo {
    RequestInfo(const uint64_t timeout_sec)
      : timeout_sec_(timeout_sec) {
        start_time_ = date_time::DateTime::getCurrentTime();
        updateEndTime();
      }

    RequestInfo(const TimevalStruct& start_time,const  uint64_t timeout_sec)
      : start_time_(start_time),
        timeout_sec_(timeout_sec) {
        updateEndTime();
    }

    virtual ~RequestInfo(){}

    virtual uint32_t requestId() = 0;
    virtual commands::Command* request() = 0;

    void updateEndTime() {
      end_time_ = date_time::DateTime::getCurrentTime();
      end_time_.tv_sec += timeout_sec_;

      // possible delay during IPC
      const uint32_t hmi_delay_sec = 1;
      end_time_.tv_sec += hmi_delay_sec;
    }

    void updateTimeOut(const uint64_t& timeout_sec) {
      timeout_sec_ = timeout_sec;
      updateEndTime();
    }

    bool isExpired() {
      if ( date_time::GREATER ==
           date_time::DateTime::compareTime(end_time_, date_time::DateTime::getCurrentTime()) ) {
        return false;
      }
      return true;
    }

    TimevalStruct start_time() {
      return start_time_;
    }

    uint64_t timeout_sec() {
      return timeout_sec_;
    }

    TimevalStruct end_time() {
      return end_time_;
    }

    uint32_t app_id() {
      return app_id_;
    }

    mobile_apis::HMILevel::eType hmi_level() {
      return hmi_level_;
    }

  protected:
    TimevalStruct                 start_time_;
    uint64_t                      timeout_sec_;
    TimevalStruct                 end_time_;
    uint32_t                      app_id_;
    mobile_apis::HMILevel::eType  hmi_level_;
  };

  typedef utils::SharedPtr<RequestInfo> RequestInfoPtr;

  struct RequestInfoComparator {
      bool operator() (const RequestInfoPtr lhs,
                       const RequestInfoPtr rhs) const {
        date_time::TimeCompare compare_result =
            date_time::DateTime::compareTime(lhs->end_time(), rhs->end_time());

        return compare_result == date_time::LESS;
      }
  };

  typedef std::set<RequestInfoPtr,RequestInfoComparator> RequestInfoSet;

  struct HMIRequestInfo: public RequestInfo {
    HMIRequestInfo(RequestPtr request, const uint64_t timeout_sec);
    HMIRequestInfo(RequestPtr request, const TimevalStruct& start_time,
                     const  uint64_t timeout_sec);

    RequestPtr request_;
    uint32_t correlation_id_;

    virtual uint32_t requestId() {
      return correlation_id_;
    }

    virtual commands::Command* request() {
      return request_.get();
    }
  };

  struct MobileRequestInfo: public RequestInfo {
    MobileRequestInfo(RequestPtr request,
                      const uint64_t timeout_sec);

    MobileRequestInfo(RequestPtr request,
                      const TimevalStruct& start_time,
                      const uint64_t timeout_sec);

    RequestPtr request_;
    uint32_t mobile_correlation_id_;

    virtual uint32_t requestId() {
      return mobile_correlation_id_;
    }

    virtual commands::Command* request() {
      return request_.get();
    }
  };

  /**
  * @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 (date_time::DateTime::getmSecs(setEntry->start_time())
          < date_time::DateTime::getmSecs(start_) ||
          date_time::DateTime::getmSecs(setEntry->start_time())
          > date_time::DateTime::getmSecs(end_)) {
        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_