summaryrefslogtreecommitdiff
path: root/src/components/application_manager/include/application_manager/command_holder_impl.h
blob: ed5f6baa621c10eb3802020b8990b391ee14c962 (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
/*
 * Copyright (c) 2017, 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_COMMAND_HOLDER_IMPL_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMAND_HOLDER_IMPL_H_

#include "application_manager/command_holder.h"

#include <string>
#include <vector>
#include <map>
#include "application_manager/application.h"
#include "smart_objects/smart_object.h"
#include "utils/lock.h"
#include "utils/shared_ptr.h"
#include "utils/macro.h"

namespace application_manager {
class ApplicationManager;
/**
 * @brief The CommandHolderImpl class should hold commands for particular
 * application during application transport switching process and sends for
 * processing after switching is completed successfully or drops otherwise
 */
class CommandHolderImpl : public CommandHolder {
 public:
  /**
   * @brief CommandHolderImpl constructor
   */

  explicit CommandHolderImpl(ApplicationManager& app_manager);

  /**
   * @brief Suspend collects command for specific application id internally
   * @param application Application pointer
   * @param type Command type
   * @param command Command
   */
  void Suspend(ApplicationSharedPtr application,
               CommandType type,
               smart_objects::SmartObjectSPtr command) FINAL;

  /**
   * @brief Resume sends all collected HMI commands to ApplicationManager
   * for further processing
   * @param application Application pointer
   * @param type Command type
   */
  void Resume(ApplicationSharedPtr application, CommandType type) FINAL;

  /**
   * @brief Clear removes all commands collected for specific application id
   * @param application Application pointer
   */
  void Clear(ApplicationSharedPtr application) FINAL;

 private:
  /**
   * @brief ResumeHmiCommand sends suspended HMI commands for processing
   * @param application Application which commands to process
   */
  void ResumeHmiCommand(ApplicationSharedPtr app);

  /**
   * @brief ResumeMobileCommand sends suspended mobile commands for processing
   * @param application Application which commands to process
   */
  void ResumeMobileCommand(ApplicationSharedPtr application);

  using AppCommands =
      std::map<ApplicationSharedPtr,
               std::vector<utils::SharedPtr<smart_objects::SmartObject> > >;

  ApplicationManager& app_manager_;
  sync_primitives::Lock commands_lock_;
  AppCommands app_mobile_commands_;
  AppCommands app_hmi_commands_;
};
}  // namespace application_manager

#endif  // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMAND_HOLDER_IMPL_H_