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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
|
/*
* @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.
*/
///////////////////////////////////////////////////////////////////////////////////////////////////
/// \brief This file contains declaration of common APIs for NS_UtilityCenter.
///
////////////////////////////////////////////////////////////////////////////////////////////////////
/**
* @file ns_utility_sys.hpp
*/
#ifndef __NSFRAMEWORK_NSUTILITY_NSUTILITYSYS__ // NOLINT (build/header_guard)
#define __NSFRAMEWORK_NSUTILITY_NSUTILITYSYS__
#include <native_service/frameworkunified_types.h>
#include <native_service/ns_utility.hpp>
#include <pthread.h>
#include <errno.h>
/** @addtogroup BaseSystem
* @{
*/
/** @addtogroup native_service
* @ingroup BaseSystem
* @{
*/
/** @addtogroup framework_unified
* @ingroup native_service
* @{
*/
/** @addtogroup native
* @ingroup framework_unified
* @{
*/
// Lock Wrapper ////////////////////////////////////////////////////////////////
/**
* \~english define the lock_error class inherit from std::runtime_error
*/
DEFINE_EXCEPTION(lock_error, std::runtime_error);
/**
* \~english define the lock_creation_error class inherit from lock_error
*/
DEFINE_EXCEPTION(lock_creation_error, lock_error);
/**
* \~english define the lock_acquireread_error class inherit from lock_error
*/
DEFINE_EXCEPTION(lock_acquireread_error, lock_error);
/**
* \~english define the lock_acquirewrite_error class inherit from lock_error
*/
DEFINE_EXCEPTION(lock_acquirewrite_error, lock_error);
/**
* \~english define the lock_release_error class inherit from lock_error
*/
DEFINE_EXCEPTION(lock_release_error, lock_error);
/**
* @class CMutex
* @brief \~english Mutex Lock Class
* @par \~english Brief Introduction
* \~english This class defines locking policy for Mutexes.
*
*/
class CMutex {
public:
////////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup NS_UtilityCenter
/// \~english @par Brief
/// Construct a CMutex object.
/// \~english @par Prerequisite
/// - None
/// \~english @par Change of internal state
/// - None
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Sync Only
/// \~english @par Detail
/// The function constructs a CMutex object.
/// \~english @see
////////////////////////////////////////////////////////////////////////////////////////////////
CMutex();
////////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup NS_UtilityCenter
/// \~english @par Brief
/// Destruct the CMutex object.
/// \~english @par Prerequisite
/// - Construct a CMutex object
/// \~english @par Change of internal state
/// - None
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Sync Only
/// \~english @par Detail
/// The function destructs the CMutex object.
/// \~english @see CMutex()
////////////////////////////////////////////////////////////////////////////////////////////////
~CMutex();
////////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup NS_UtilityCenter
/// \~english @par Brief
/// Lock the CMutex object when reading.
/// \~english @retval void
///
/// \~english @par Prerequisite
/// - Construct a CMutex object
/// \~english @par Change of internal state
/// - None
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Sync Only
/// \~english @par Detail
/// The function locks the CMutex object when reading.
/// \~english @see CMutex(), WriteLock(), UnLock()
////////////////////////////////////////////////////////////////////////////////////////////////
void ReadLock();
////////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup NS_UtilityCenter
/// \~english @par Brief
/// Lock the CMutex object when writing.
/// \~english @retval void
///
/// \~english @par Prerequisite
/// - Construct a CMutex object
/// \~english @par Change of internal state
/// - None
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Sync Only
/// \~english @par Detail
/// The function locks the CMutex object when writing.
/// \~english @see CMutex(), ReadLock(), UnLock()
////////////////////////////////////////////////////////////////////////////////////////////////
void WriteLock();
////////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup NS_UtilityCenter
/// \~english @par Brief
/// Open the lock of the CMutex object.
/// \~english @retval void
///
/// \~english @par Prerequisite
/// - Construct a CMutex object
/// \~english @par Change of internal state
/// - None
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Sync Only
/// \~english @par Detail
/// The function opens the lock of the CMutex object.
/// \~english @see CMutex(), ReadLock(), WriteLock()
////////////////////////////////////////////////////////////////////////////////////////////////
void Unlock();
private:
pthread_mutex_t m_mtx;
};
/**
* @class CRWLock
* @brief \~english Read/Write Lock Class
* @par \~english Brief Introduction
* \~english This class defines locking policy for reader/writer.
*
*/
class CRWLock {
public:
////////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup NS_UtilityCenter
/// \~english @par Brief
/// - Construct a CRWLock object.
/// \~english @par Prerequisite
/// - None
/// \~english @par Change of internal state
/// - None
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Sync Only
/// \~english @par Detail
/// The function constructs a CRWLock object.
/// \~english @see ~CRWLock()
////////////////////////////////////////////////////////////////////////////////////////////////
CRWLock();
////////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup NS_UtilityCenter
/// \~english @par Brief
/// Destruct the CRWLock object.
/// \~english @par Prerequisite
/// - Construct a CRWLock object.
/// \~english @par Change of internal state
/// - None
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Sync Only
/// \~english @par Detail
/// The function destructs the CRWLock object.
/// \~english @see CRWLock()
////////////////////////////////////////////////////////////////////////////////////////////////
~CRWLock();
////////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup NS_UtilityCenter
/// \~english @par Brief
/// Lock the CRWLock object when reading.
/// \~english @retval void
///
/// \~english @par Prerequisite
/// - Construct a CRWLock object.
/// \~english @par Change of internal state
/// - None
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Sync Only
/// \~english @par Detail
/// The function locks the CRWLock object when reading.
/// \~english @see CRWLock(), WriteLock(), UnLoack()
////////////////////////////////////////////////////////////////////////////////////////////////
void ReadLock();
////////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup NS_UtilityCenter
/// \~english @par Brief
/// Lock the CRWLock object when writing.
/// \~english @retval void
///
/// \~english @par Prerequisite
/// - Construct a CRWLock object.
/// \~english @par Change of internal state
/// - None
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Sync Only
/// \~english @par Detail
/// The function locks the CRWLock object when writing.
/// \~english @see CRWLock(), ReadLock(), UnLock()
////////////////////////////////////////////////////////////////////////////////////////////////
void WriteLock();
////////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup NS_UtilityCenter
/// \~english @par Brief
/// Open the lock of CRWLock object
/// \~english @retval void
///
/// \~english @par Prerequisite
/// - Construct a CRWLock object.
/// \~english @par Change of internal state
/// - None
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Sync Only
/// \~english @par Detail
/// The function opens the lock of the CRWLock object.
/// \~english @see CRWLock(), ReadLock(), WriteLock()
////////////////////////////////////////////////////////////////////////////////////////////////
void Unlock();
private:
pthread_rwlock_t m_rwl;
};
#endif // __NSFRAMEWORK_NSUTILITY_NSUTILITYSYS__ // NOLINT (build/header_guard)
/** @}*/ // end of native
/** @}*/ // end of framework_unified
/** @}*/ // end of native_service
/** @}*/ // end of BaseSystem
|
