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
|
/*
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_COMMANDS_COMMAND_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMANDS_COMMAND_H_
#include <stdint.h>
#include "application_manager/hmi_state.h"
#include "smart_objects/smart_object.h"
namespace application_manager {
namespace commands {
/**
* @brief Base command class
**/
class Command {
public:
/**
* @brief Checks command permissions according to policy table
*/
virtual bool CheckPermissions() = 0;
/**
* @brief Command initialization function
**/
virtual bool Init() = 0;
/**
* @brief Execute command
**/
virtual void Run() = 0;
/**
* @brief Free resources
**/
virtual bool CleanUp() = 0;
/**
* \brief Command class destructor
**/
virtual ~Command() {}
/**
* @brief Retrieves request default timeout.
* If request has a custom timeout, request_timeout_ should be reassign to it
*
* @return Request default timeout
*/
virtual uint32_t default_timeout() const = 0;
/*
* @brief Retrieves correlation ID
*/
virtual uint32_t correlation_id() const = 0;
/*
* @brief Retrieves connection_key
*/
virtual uint32_t connection_key() const = 0;
/*
* @brief Retrieves request ID
*/
virtual int32_t function_id() const = 0;
/*
* @brief Retrieves Window ID
*/
virtual WindowID window_id() const = 0;
/**
* @brief Set warning info string, to be sent on a successful response
* @param info Warning info string
*/
virtual void set_warning_info(const std::string info) = 0;
/**
* @brief Returns warning info string
* @return Warning info string
*/
virtual std::string warning_info() const = 0;
/*
* @brief Function is called by RequestController when request execution time
* has exceed it's limit
*
*/
virtual void HandleTimeOut() = 0;
/**
* @brief Function is called by RequestInfo when request controller
* updates request timeout
* Function sets request state to "AwaitingResponse"
*/
virtual void OnUpdateTimeOut() = 0;
/**
* @brief AllowedToTerminate tells if request controller is allowed
* to terminate this command
* @return
*/
virtual bool AllowedToTerminate() = 0;
/**
* @brief SetAllowedToTerminate set up allowed to terminate flag.
* If true, request controller will terminate request on response
*/
virtual void SetAllowedToTerminate(const bool allowed) = 0;
enum CommandSource {
SOURCE_SDL,
SOURCE_MOBILE,
SOURCE_HMI,
SOURCE_SDL_TO_HMI
};
};
typedef smart_objects::SmartObjectSPtr MessageSharedPtr;
} // namespace commands
} // namespace application_manager
#endif // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMANDS_COMMAND_H_
|
