blob: b142d11047002caa9af4ba71fd662af7b7c0c160 (
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
263
264
265
266
267
|
/*
* @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
////////////////////////////////////////////////////////////////////////////////
/// \ingroup tag_HMI_CWORD77_Controller
/// \brief
///
///
///
////////////////////////////////////////////////////////////////////////////////
//@{
/**
* @file frameworkunified_service_if.h
* @brief \~english This is base class for service interface classes
*
*/
/** @addtogroup BaseSystem
* @{
*/
/** @addtogroup native_service
* @ingroup BaseSystem
* @{
*/
/** @addtogroup framework_unified
* @ingroup native_service
* @{
*/
/** @addtogroup framework
* @ingroup native_service
* @{
*/
#ifndef __CSERVICESESSION_H__ // NOLINT (build/header_guard)
#define __CSERVICESESSION_H__
#include <native_service/frameworkunified_service_protocol.h>
#include <native_service/frameworkunified_framework_if.h>
#include <string>
///////////////////////////////////////////////////////////////////////////
/// class: CServiceSession
/// Description: This is base class for service interface classes
///
////////////////////////////////////////////////////////////////////////////
class CFrameworkunifiedServiceInterface {
public:
////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedServiceInterface
/// \~english @par Brief
/// Constructor for CFrameworkunifiedServiceInterface
/// \~english @retval none
/// \~english @par Preconditions
/// no preconditions
/// \~english @par Change of internal status
/// none
/// \~english @par Conditions of processing failure
/// none
/// \~english @par Detail
/// create CFrameworkunifiedServiceInterface class instance
/// \~english @par Classification
/// public
/// \~english @par Type
/// none
/// \~english @see ~CFrameworkunifiedServiceInterface
////////////////////////////////////////////////////////////////////////////////////////////
CFrameworkunifiedServiceInterface();
////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedServiceInterface
/// \~english @par Brief
/// Destructor for CFrameworkunifiedServiceInterface
/// \~english @retval none
/// \~english @par Preconditons
/// CFrameworkunifiedServiceInterface is decleared in constructor
/// \~english @par Change of internal status
/// none
/// \~english @par Conditions of processing failure
/// none
/// \~english @par Detail
/// Release CFrameworkunifiedServiceInterface instance
/// \~english @par Classification
/// public
/// \~english @par Type
/// none
/// \~english @see CFrameworkunifiedServiceInterface
////////////////////////////////////////////////////////////////////////////////////////////
~CFrameworkunifiedServiceInterface();
////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedServiceInterface
/// \~english @par Brief
/// API to open Service.
/// \~english @param [in] f_hApp
/// HANDLE* - Handle of framework
/// \~english @param [in] f_sServiceName
/// std::string - Service Name
/// \~english @retval HANDLE
/// \~english @par Preconditions
/// - no preconditions
/// \~english @par Change of internal status
/// - none
/// \~english @par Conditions of processing failure
/// - none
/// \~english @par Detail
/// Open service by specified name and retrun handle of service. \n
/// If FrameworkunifiedOpenService failed, handle is NULL.\n
/// \~english @par Classification
/// public
/// \~english @par Type
/// sync only
/// \~english @see FrameworkunifiedOpenService
////////////////////////////////////////////////////////////////////////////////////////////
HANDLE OpenService(const HANDLE f_hApp, std::string f_sServiceName);
////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedServiceInterface
/// \~english @par Brief
/// API to close service.
/// \~english @param [in] f_hApp
/// HANDLE* - Handle of framework
/// \~english @param [in] f_hService
/// HANDLE - Handle of the service
/// \~english @retval EFrameworkunifiedStatus
/// Success or Error
/// \~english @par Preconditons
/// - none
/// \~english @par Change of internal status
/// - none
/// \~english @par Conditions of processing failure
/// - If parameter f_hApp is NULL. [eFrameworkunifiedStatusInvldParam]
/// - If parameter f_hService is NULL. [eFrameworkunifiedStatusInvldParam]
/// - If FrameworkunifiedCloseService failed. [eFrameworkunifiedStatusInvldHandle]
/// \~english @par Detail
/// close service by handle \n
/// \~english @par Classification
/// public
/// \~english @par Type
/// sync only
/// \~english @see FrameworkunifiedCloseService
////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus CloseService(const HANDLE f_hApp, const HANDLE f_hService);
////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedServiceInterface
/// \~english @par Brief
/// API to open session
/// \~english @param [in] f_hApp
/// HANDLE* -framework handle
/// \~english @param [in] f_uisessionType
/// UI_32 - sessiontype
/// \~english @retval EFrameworkunifiedStatus
/// Success or Error
/// \~english @par Preconditons
/// - none
/// \~english @par Change of internal status
/// - none
/// \~english @par Conditions of processing failure
/// - If parameter f_hApp is NULL. [eFrameworkunifiedStatusInvldParam]
/// - If FrameworkunifiedOpenSessionWithData failed. [eFrameworkunifiedStatusInvldHandle]
/// \~english @par Detail
/// open session by specified session type \n
/// \~english @par Classification
/// public
/// \~english @par Type
/// sync only
/// \~english @see FrameworkunifiedOpenSessionWithData
////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus OpenSession(const HANDLE f_hApp, UI_32 f_uisessionType);
////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedServiceInterface
/// \~english @par Brief
/// API to open session Acknowledge
/// \~english @param [in] f_hApp
/// HANDLE* - Handle of framework
/// \~english @param [in] hSession
/// HANDLE - Session Handle
/// \~english @retval EFrameworkunifiedStatus
/// Success or Error
/// \~english @par Preconditons
/// - none
/// \~english @par Change of internal status
/// - none
/// \~english @par Conditions of processing failure
/// none
/// \~english @par Detail
/// Empty implement.\n
/// \~english @par Classification
/// public
/// \~english @par Type
/// sync only
/// \~english @see one
////////////////////////////////////////////////////////////////////////////////////////////
virtual EFrameworkunifiedStatus OpenSessionAcknowledge(const HANDLE f_hApp, HANDLE &hSession); // NOLINT (readability/nolint)
////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedServiceInterface
/// \~english @par Brief
/// API to close session.
/// \~english @param [in] f_hService
/// HANDLE* - Handle of service
/// \~english @param [in] hSession
/// HANDLE - Session Handle
/// \~english @retval EFrameworkunifiedStatus
/// Success or Error
/// \~english @par Preconditons
/// - none
/// \~english @par Change of internal status
/// - none
/// \~english @par Conditions of processing failure
/// - If parameter f_hService is NULL. [eFrameworkunifiedStatusInvldParam]
/// - If parameter f_hSession is NULL. [eFrameworkunifiedStatusInvldParam]
/// - If FrameworkunifiedCloseSession failed. [eFrameworkunifiedStatusInvldHandle]
/// \~english @par Detail
/// close session of specified service. \n
/// \~english @par Classification
/// public
/// \~english @par Type
/// sync only
/// \~english @see FrameworkunifiedCloseSession
////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus CloseSession(const HANDLE f_hService, const HANDLE f_hSession);
////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup CFrameworkunifiedServiceInterface
/// \~english @par Brief
/// API to close session.
/// \~english @param [in] f_hService
/// HANDLE* - Handle of service
/// \~english @param [in] hSession
/// HANDLE - Session Handle
/// \~english @retval EFrameworkunifiedStatus
/// Success or Error
/// \~english @par Preconditons
/// - none
/// \~english @par Change of internal status
/// - none
/// \~english @par Conditions of processing failure
/// - If parameter hClient is NULL. [eFrameworkunifiedStatusNullPointer]
/// - If FrameworkunifiedGetMsgDataOfSize failed. [eFrameworkunifiedStatusNullPointer]
/// \~english @par Detail
/// Check close session acknowledge.\n
/// \~english @par Classification
/// public
/// \~english @par Type
/// sync only
/// \~english @see FrameworkunifiedGetMsgDataOfSize
////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus CloseSessionAcknowledge(const HANDLE hClient);
};
#endif // __CSERVICESESSION_H__ NOLINT (build/header_guard)
/** @}*/
/** @}*/
/** @}*/
/** @}*/
//@}
|
