RTI Connext DDS Micro  Version 2.4.9
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
rh_sm_log.h
Go to the documentation of this file.
1 /*
2  * FILE: rh_sm_log.h - Reader Log definitions
3  *
4  * (c) Copyright 2008-2015 Real-Time Innovations,
5  *
6  * All rights reserved.
7  *
8  * No duplications, whole or partial, manual or electronic, may be made
9  * without express written permission. Any such copies, or
10  * revisions thereof, must display this notice unaltered.
11  * This code contains trade secrets of Real-Time Innovations, Inc.
12  *
13  * Modification History
14  * --------------------
15  * 16aug2011,tk Created
16  */
17 /*ce
18  * \file
19  * \brief RH module log codes
20  */
21 #ifndef rh_sm_log_h
22 #define rh_sm_log_h
23 
24 #ifndef osapi_log_h
25 #include "osapi/osapi_log.h"
26 #endif
27 
28 /*ce
29  * \defgroup RHLogCodesClass RH
30  * \brief Reader History. ModuleID = 8
31  * \ingroup LoggingModule
32  */
33 
34 /*ce
35  * \brief Failed to delete Reader History due to outstanding, unremoved sample
36  * \ingroup RHLogCodesClass
37  */
38 #define RHSM_LOG_OUTSTANDING_SAMPLE_EC (RHSM_LOG_BASE + 1)
39 #define RHSM_LOG_OUTSTANDING_SAMPLE(level_) \
40 OSAPI_LOG_ENTRY_ADD((level_),RHSM_LOG_OUTSTANDING_SAMPLE_EC,\
41  OSAPI_LOG_MSG_PN_X2_STD_PARAM)
42 
43 /*ce
44  * \brief Failed to create Reader History due to unspecified property Qos
45  * \ingroup RHLogCodesClass
46  */
47 #define RHSM_LOG_NO_PROPERTY_QOS_EC (RHSM_LOG_BASE + 2)
48 #define RHSM_LOG_NO_PROPERTY_QOS(level_) \
49 OSAPI_LOG_ENTRY_ADD((level_),RHSM_LOG_NO_PROPERTY_QOS_EC,\
50  OSAPI_LOG_MSG_PN_X2_STD_PARAM)
51 
52 /*ce
53  * \brief KEEP_ALL History kind is not supported
54  * \ingroup RHLogCodesClass
55  */
56 #define RHSM_LOG_KEEP_ALL_HISTORY_NOT_SUPPORTED_EC (RHSM_LOG_BASE + 3)
57 #define RHSM_LOG_KEEP_ALL_HISTORY_NOT_SUPPORTED(level_) \
58 OSAPI_LOG_ENTRY_ADD((level_),RHSM_LOG_KEEP_ALL_HISTORY_NOT_SUPPORTED_EC,\
59  OSAPI_LOG_MSG_PN_X2_STD_PARAM)
60 
61 /*ce
62  * \brief DataReaderQos.resource_limits.max_samples set too small
63  *
64  * \details DataReaderQos.resource_limits.max_samples too small, must be at least
65  * DataReaderQos.resource_limits.max_instances *
66  * DataReaderQos.resource_limits.max_samples_per_instance
67  * \ingroup RHLogCodesClass
68  */
69 #define RHSM_LOG_MAX_SAMPLE_TOO_SMALL_EC (RHSM_LOG_BASE + 4)
70 #define RHSM_LOG_MAX_SAMPLE_TOO_SMALL(level_) \
71 OSAPI_LOG_ENTRY_ADD((level_),RHSM_LOG_MAX_SAMPLE_TOO_SMALL_EC,\
72  OSAPI_LOG_MSG_PN_X2_STD_PARAM)
73 
74 /*ce
75  * \brief Time-based filtering is not supported
76  * \ingroup RHLogCodesClass
77  */
78 #define RHSM_LOG_TBF_NOT_SUPPORTED_EC (RHSM_LOG_BASE + 5)
79 #define RHSM_LOG_TBF_NOT_SUPPORTED(level_) \
80 OSAPI_LOG_ENTRY_ADD((level_),RHSM_LOG_TBF_NOT_SUPPORTED_EC,\
81  OSAPI_LOG_MSG_PN_X2_STD_PARAM)
82 
83 /*ce
84  * \brief Failed to allocate a buffer pool for sample info
85  * \ingroup RHLogCodesClass
86  */
87 #define RHSM_LOG_SAMPLE_INFO_POOL_EC (RHSM_LOG_BASE + 6)
88 #define RHSM_LOG_SAMPLE_INFO_POOL(level_,size_,count_) \
89 OSAPI_LOG_ENTRY_ADD_2INT((level_),RHSM_LOG_SAMPLE_INFO_POOL_EC,\
90  OSAPI_LOG_MSG_PN_X2_STD_PARAM ,\
91  "size",(size_),"count=%d",(count_))
92 
93 /*ce
94  * \brief Failed to allocate a buffer pool for sample pointers
95  * \ingroup RHLogCodesClass
96  */
97 #define RHSM_LOG_SAMPLE_POOL_EC (RHSM_LOG_BASE + 7)
98 #define RHSM_LOG_SAMPLE_POOL(level_,size_,count_) \
99 OSAPI_LOG_ENTRY_ADD_2INT((level_),RHSM_LOG_SAMPLE_POOL_EC,\
100  OSAPI_LOG_MSG_PN_X2_STD_PARAM,\
101  "size",(size_),"count=%d",(count_))
102 
103 /*ce
104  * \brief Failed to get sample buffer.
105  *
106  * \details May have exceeded
107  * DataReaderQos.reader_resource_limits.max_outstanding_reads
108  * \ingroup RHLogCodesClass
109  */
110 #define RHSM_LOG_SAMPLE_PTR_ARRAY_EC (RHSM_LOG_BASE + 8)
111 #define RHSM_LOG_SAMPLE_PTR_ARRAY(level_) \
112 OSAPI_LOG_ENTRY_ADD((level_),RHSM_LOG_SAMPLE_PTR_ARRAY_EC,\
113  OSAPI_LOG_MSG_PN_X2_STD_PARAM)
114 
115 /*ce
116  * \brief Failed to get sample info buffer.
117  *
118  * \details May have exceeded
119  * DataReaderQos.reader_resource_limits.max_outstanding_reads
120  * \ingroup RHLogCodesClass
121  */
122 #define RHSM_LOG_INFO_ARRAY_EC (RHSM_LOG_BASE + 9)
123 #define RHSM_LOG_INFO_ARRAY(level_) \
124 OSAPI_LOG_ENTRY_ADD((level_),RHSM_LOG_INFO_ARRAY_EC,\
125  OSAPI_LOG_MSG_PN_X2_STD_PARAM)
126 
127 /*ce
128  * \brief Failed to get time for reception timestamp.
129  *
130  * \ingroup RHLogCodesClass
131  */
132 #define RHSM_LOG_GET_RECEPTION_TIMESTAMP_EC (RHSM_LOG_BASE + 10)
133 #define RHSM_LOG_GET_RECEPTION_TIMESTAMP(level_) \
134 OSAPI_LOG_ENTRY_ADD((level_),RHSM_LOG_GET_RECEPTION_TIMESTAMP_EC,\
135  OSAPI_LOG_MSG_PN_X2_STD_PARAM)
136 
137 /*ce
138  * \brief An invalid instance replacement policy was specified.
139  *
140  * \ingroup RHLogCodesClass
141  */
142 #define RHSM_LOG_INVALID_INSTANCE_REPLACEMENT_EC (RHSM_LOG_BASE + 11)
143 #define RHSM_LOG_INVALID_INSTANCE_REPLACEMENT(level_,kind_) \
144 OSAPI_LOG_ENTRY_ADD_1INT((level_),RHSM_LOG_INVALID_INSTANCE_REPLACEMENT_EC,\
145  OSAPI_LOG_MSG_PN_X2_STD_PARAM ,"kind",kind_)
146 
147 /*ce
148  * \brief Failed to remove the oldest sample
149  *
150  * \ingroup RHLogCodesClass
151  */
152 #define RHSM_LOG_FAILED_TO_REMOVE_OLDEST_EC (RHSM_LOG_BASE + 12)
153 #define RHSM_LOG_FAILED_TO_REMOVE_OLDEST(level_) \
154 OSAPI_LOG_ENTRY_ADD((level_),RHSM_LOG_FAILED_TO_REMOVE_OLDEST_EC,\
155  OSAPI_LOG_MSG_PN_X2_STD_PARAM)
156 
157 /*ce
158  * \brief Sample pool empty, may have exceeded
159  *
160  * \details
161  *
162  * The sample pool is empty, may have exceeded
163  * DataReaderQos.resource_limits.max_samples
164  *
165  * \ingroup RHLogCodesClass
166  */
167 #define RHSM_LOG_SAMPLE_POOL_EMPTY_EC (RHSM_LOG_BASE + 13)
168 #define RHSM_LOG_SAMPLE_POOL_EMPTY(level_) \
169 OSAPI_LOG_ENTRY_ADD((level_),RHSM_LOG_SAMPLE_POOL_EMPTY_EC,\
170  OSAPI_LOG_MSG_PN_X2_STD_PARAM)
171 
172 /*ce
173  * \brief Failed to prune remote writer entry
174  *
175  * \ingroup RHLogCodesClass
176  */
177 #define RHSM_LOG_RW_PRUNE_FAILED_EC (RHSM_LOG_BASE + 14)
178 #define RHSM_LOG_RW_PRUNE_FAILED(level_) \
179 OSAPI_LOG_ENTRY_ADD((level_),RHSM_LOG_RW_PRUNE_FAILED_EC,\
180  OSAPI_LOG_MSG_PN_X2_STD_PARAM)
181 
182 /*ce
183  * \brief Failed to reserve an entry
184  *
185  * \details
186  *
187  * An entry reservation failed beyond normal resource settings
188  *
189  * \ingroup RHLogCodesClass
190  */
191 #define RHSM_LOG_ENTRY_RESERVATION_FAILED_EC (RHSM_LOG_BASE + 15)
192 #define RHSM_LOG_ENTRY_RESERVATION_FAILED(level_,reason_) \
193 OSAPI_LOG_ENTRY_ADD_1INT((level_),RHSM_LOG_ENTRY_RESERVATION_FAILED_EC,\
194  OSAPI_LOG_MSG_PN_X2_STD_PARAM ,"reason",(reason_))
195 
196 /*ce
197  * \brief Failed to return a sample
198  *
199  * \ingroup RHLogCodesClass
200  */
201 #define RHSM_LOG_RETURN_SAMPLE_EC (RHSM_LOG_BASE + 16)
202 #define RHSM_LOG_RETURN_SAMPLE(level_) \
203 OSAPI_LOG_ENTRY_ADD((level_),RHSM_LOG_RETURN_SAMPLE_EC,\
204  OSAPI_LOG_MSG_PN_X2_STD_PARAM)
205 
206 /*ce
207  * \brief Failed to update the history queue
208  *
209  * \ingroup RHLogCodesClass
210  */
211 #define RHSM_LOG_HISTORY_UPDATE_EC (RHSM_LOG_BASE + 17)
212 #define RHSM_LOG_HISTORY_UPDATE(level_) \
213 OSAPI_LOG_ENTRY_ADD((level_),RHSM_LOG_HISTORY_UPDATE_EC,\
214  OSAPI_LOG_MSG_PN_X2_STD_PARAM)
215 
216 
217 /*ce
218  * \brief Failed to get the system time
219  *
220  * \ingroup RHLogCodesClass
221  */
222 #define RHSM_LOG_GET_TIME_EC (RHSM_LOG_BASE + 18)
223 #define RHSM_LOG_GET_TIME(level_) \
224 OSAPI_LOG_ENTRY_ADD((level_),RHSM_LOG_GET_TIME_EC,\
225  OSAPI_LOG_MSG_PN_X2_STD_PARAM)
226 
227 
228 /*ce
229  * \brief A history object
230  */
231 #define RHSM_LOG_HISTORY_OBJECT 1
232 
233 /*ce
234  * \brief A removal list object
235  */
236 #define RHSM_LOG_REMOVELIST_OBJECT 2
237 
238 /*ce
239  * \brief A remote writer pool object
240  */
241 #define RHSM_LOG_RWPOOL_OBJECT 3
242 
243 /*ce
244  * \brief A remote writer index object
245  */
246 #define RHSM_LOG_RWINDEX_OBJECT 4
247 
248 /*ce
249  * \brief A Key object
250  */
251 #define RHSM_LOG_KEY_OBJECT 5
252 
253 /*ce
254  * \brief A Key object
255  */
256 #define RHSM_LOG_RW_OBJECT 6
257 
258 /*ce
259  * \brief A Key pool object
260  */
261 #define RHSM_LOG_KEYPOOL_OBJECT 7
262 
263 /*ce
264  * \brief A key owner object
265  */
266 #define RHSM_LOG_OWNER_OBJECT 8
267 
268 /*ce
269  * \brief A sample pool object
270  */
271 #define RHSM_LOG_SAMPLEPOOL_OBJECT 9
272 
273 /*ce
274  * \brief A key index pool
275  */
276 #define RHSM_LOG_KEYINDEXPOOL_OBJECT 10
277 
278 /*ce
279  * \brief A sample ptr pool object
280  */
281 #define RHSM_LOG_SAMPLEPTPOOL_OBJECT 11
282 
283 /*ce
284  * \brief A sample info pool
285  */
286 #define RHSM_LOG_SAMPLEINFO_OBJECT 12
287 
288 /*ce
289  * \brief A sample info pool
290  */
291 #define RHSM_LOG_INSTANCEHANDLE_OBJECT 13
292 
293 /*ce
294  * \brief Failed to allocate object of the specified kind
295  *
296  * \ingroup RHLogCodesClass
297  */
298 #define RHSM_LOG_OBJECT_ALLOCATE_EC (RHSM_LOG_BASE + 19)
299 #define RHSM_LOG_OBJECT_ALLOCATE(level_,kind_) \
300 OSAPI_LOG_ENTRY_ADD_1INT((level_),RHSM_LOG_OBJECT_ALLOCATE_EC,\
301  OSAPI_LOG_MSG_PN_X2_STD_PARAM ,"kind",(kind_))
302 
303 
304 /*ce
305  * \brief Failed to delete object of the specified kind
306  *
307  * \ingroup RHLogCodesClass
308  */
309 #define RHSM_LOG_OBJECT_DELETE_EC (RHSM_LOG_BASE + 20)
310 #define RHSM_LOG_OBJECT_DELETE(level_,kind_) \
311 OSAPI_LOG_ENTRY_ADD_1INT((level_),RHSM_LOG_OBJECT_DELETE_EC,\
312  OSAPI_LOG_MSG_PN_X2_STD_PARAM, "kind",(kind_))
313 
314 /*ce
315  * \brief Failed to index an object of the specified kind
316  *
317  * \ingroup RHLogCodesClass
318  */
319 #define RHSM_LOG_OBJECT_INDEX_EC (RHSM_LOG_BASE + 21)
320 #define RHSM_LOG_OBJECT_INDEX(level_,kind_) \
321 OSAPI_LOG_ENTRY_ADD_1INT((level_),RHSM_LOG_OBJECT_INDEX_EC,\
322  OSAPI_LOG_MSG_PN_X2_STD_PARAM ,"kind",(kind_))
323 
324 
325 /*ce
326  * \brief Invalid object specified
327  *
328  * \ingroup RHLogCodesClass
329  */
330 #define RHSM_LOG_OBJECT_INVALID_EC (RHSM_LOG_BASE + 22)
331 #define RHSM_LOG_OBJECT_INVALID(level_,kind_) \
332 OSAPI_LOG_ENTRY_ADD_1INT((level_),RHSM_LOG_OBJECT_INVALID_EC,\
333  OSAPI_LOG_MSG_PN_X2_STD_PARAM ,"kind",(kind_))
334 
335 /*ce
336  * \brief No property when creating a reader history instance
337  *
338  * \ingroup RHLogCodesClass
339  */
340 #define RHSM_LOG_NO_PROPERTY_EC (RHSM_LOG_BASE + 23)
341 #define RHSM_LOG_NO_PROPERTY(level_) \
342 OSAPI_LOG_ENTRY_ADD((level_),RHSM_LOG_NO_PROPERTY_EC,\
343  OSAPI_LOG_MSG_PN_X2_STD_PARAM)
344 
345 #endif
346 

RTI Connext DDS Micro Version 2.4.9 Copyright © Thu Dec 15 2016 Real-Time Innovations, Inc