summaryrefslogtreecommitdiff
path: root/src/components/application_manager/rpc_plugins/sdl_rpc_plugin/include/sdl_rpc_plugin/commands/mobile/delete_interaction_choice_set_request.h
blob: ad478bc70d0ba5aee3df580dab085715a6ee1e08 (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
/*

 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_RPC_PLUGINS_SDL_RPC_PLUGIN_INCLUDE_SDL_RPC_PLUGIN_COMMANDS_MOBILE_DELETE_INTERACTION_CHOICE_SET_REQUEST_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_RPC_PLUGINS_SDL_RPC_PLUGIN_INCLUDE_SDL_RPC_PLUGIN_COMMANDS_MOBILE_DELETE_INTERACTION_CHOICE_SET_REQUEST_H_

#include <cstdint>
#include <set>

#include "application_manager/application.h"
#include "application_manager/commands/command_request_impl.h"
#include "application_manager/commands/request_from_mobile_impl.h"
#include "utils/macro.h"

namespace sdl_rpc_plugin {
namespace app_mngr = application_manager;

namespace commands {

typedef std::set<uint32_t> SentRequestsSet;

/**
 * @brief DeleteInteractionChoiceSetRequest command class
 **/
class DeleteInteractionChoiceSetRequest
    : public app_mngr::commands::RequestFromMobileImpl {
 public:
  /**
   * @brief DeleteInteractionChoiceSetRequest class constructor
   *
   * @param message Incoming SmartObject message
   **/
  DeleteInteractionChoiceSetRequest(
      const app_mngr::commands::MessageSharedPtr& message,
      app_mngr::ApplicationManager& application_manager,
      app_mngr::rpc_service::RPCService& rpc_service,
      app_mngr::HMICapabilities& hmi_capabilities,
      policy::PolicyHandlerInterface& policy_handler);

  /**
   * @brief DeleteInteractionChoiceSetRequest class destructor
   **/
  ~DeleteInteractionChoiceSetRequest();

  /**
   * @brief Execute command
   **/
  void Run() FINAL;

  /**
   * @brief Init sets hash update mode for request
   */
  bool Init() FINAL;

  /**
   * @brief Interface method that is called whenever new event received
   * Need to observe VR_DeleteCommand event, to send
   * DeleteInteractionChoiceSetResponse when VR command was delete from HMI.
   * @param event The received event.
   */
  void on_event(const app_mngr::event_engine::Event& event) FINAL;

 private:
  /*
   * @brief Check if requested choice set ID in use by perform interaction
   *
   * @param app mobile application
   */
  bool ChoiceSetInUse(app_mngr::ApplicationConstSharedPtr app);

  void SendVrDeleteCommand(app_mngr::ApplicationSharedPtr app);

  void SendDeleteInteractionChoiceSetResponse();

  /**
   * @brief Final result_code for sending to Mobile.
   */
  std::vector<hmi_apis::Common_Result::eType> response_result_codes_;

  sync_primitives::Lock requests_lock_;

  /**
   * @brief Collection that contains sent request to HMI.
   * When HMI response will start come, that collection will helps to control,
   * when SDL should sends DeleteInteractionChoiceSetResponse to Mobile.
   * Because, for send DeleteInteractionChoiceSetResponse SDL should will be saw
   * all response results from HMI.
   */
  SentRequestsSet sent_requests_;

  DISALLOW_COPY_AND_ASSIGN(DeleteInteractionChoiceSetRequest);
};

}  // namespace commands
}  // namespace sdl_rpc_plugin

#endif  // SRC_COMPONENTS_APPLICATION_MANAGER_RPC_PLUGINS_SDL_RPC_PLUGIN_INCLUDE_SDL_RPC_PLUGIN_COMMANDS_MOBILE_DELETE_INTERACTION_CHOICE_SET_REQUEST_H_