RTI Connext DDS Micro  Version 2.4.8
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
wh_sm_log.h
Go to the documentation of this file.
1 /*
2  * FILE: wh_sm_log.h - Writer Log definitions
3  *
4  * (c) Copyright 2011-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 
18 /*ce
19  * \file
20  * \brief WH module log codes
21  */
22 #ifndef wh_sm_log_h
23 #define wh_sm_log_h
24 
25 #ifndef osapi_log_h
26 #include "osapi/osapi_log.h"
27 #endif
28 
29 /*ce
30  * \defgroup WHLogCodesClass WH
31  * \brief Writer History. ModuleID = 9
32  * \ingroup LoggingModule
33  */
34 
35 /*ce
36  * \brief KEEP_ALL History kind is not supported
37  * \ingroup WHLogCodesClass
38  */
39 #define WHSM_LOG_KEEP_ALL_HISTORY_NOT_SUPPORTED_EC (WHSM_LOG_BASE + 1)
40 #define WHSM_LOG_KEEP_ALL_HISTORY_NOT_SUPPORTED(level_) \
41 OSAPI_LOG_ENTRY_ADD((level_),WHSM_LOG_KEEP_ALL_HISTORY_NOT_SUPPORTED_EC,\
42  OSAPI_LOG_MSG_PN_X2_STD_PARAM)
43 
44 /*ce
45  * \brief Unlimited length resource limits unsupported
46  * \details Ensure that max_samples, max_samples_per_instance, and max_instances
47  * resource limits are all finite values
48  * \ingroup WHLogCodesClass
49  */
50 #define WHSM_LOG_UNLIMITED_HISTORY_NOT_SUPPORTED_EC (WHSM_LOG_BASE + 2)
51 #define WHSM_LOG_UNLIMITED_HISTORY_NOT_SUPPORTED(level_) \
52 OSAPI_LOG_ENTRY_ADD((level_),WHSM_LOG_UNLIMITED_HISTORY_NOT_SUPPORTED_EC,\
53  OSAPI_LOG_MSG_PN_X2_STD_PARAM)
54 
55 /*ce
56  * \brief DataWriterQos.resource_limits.max_samples set too small
57  *
58  * \details DataWriterQos.resource_limits.max_samples must be
59  * no less than max_instances * max_samples_per_instance
60  * \ingroup WHLogCodesClass
61  */
62 #define WHSM_LOG_MAX_SAMPLES_TOO_SMALL_EC (WHSM_LOG_BASE + 3)
63 #define WHSM_LOG_MAX_SAMPLES_TOO_SMALL(level_) \
64 OSAPI_LOG_ENTRY_ADD((level_),WHSM_LOG_MAX_SAMPLES_TOO_SMALL_EC,\
65  OSAPI_LOG_MSG_PN_X2_STD_PARAM)
66 
67 /*ce
68  * \brief A history object
69  */
70 #define WHSM_LOG_HISTORY_OBJECT 1
71 
72 /*ce
73  * \brief A key object
74  */
75 #define WHSM_LOG_KEY_OBJECT 2
76 
77 /*ce
78  * \brief A sample object
79  */
80 #define WHSM_LOG_SAMPLE_OBJECT 2
81 
82 /*ce
83  * \brief A key-pool object
84  */
85 #define WHSM_LOG_KEYPOOL_OBJECT 3
86 
87 /*ce
88  * \brief A sample-pool object
89  */
90 #define WHSM_LOG_SAMPLEPOOL_OBJECT 4
91 
92 /*ce
93  * \brief A key index pool
94  */
95 #define WHSM_LOG_KEYINDEX_OBJECT 5
96 
97 /*ce
98  * \brief A key index pool
99  */
100 #define WHSM_LOG_HISTORYINDEX_OBJECT 6
101 
102 /*ce
103  * \brief A key index pool
104  */
105 #define WHSM_LOG_SAMPLEINDEX_OBJECT 5
106 
107 /*ce
108  * \brief Failed to allocate object of the specified kind
109  *
110  * \ingroup WHLogCodesClass
111  */
112 #define WHSM_LOG_OBJECT_ALLOCATE_EC (WHSM_LOG_BASE + 4)
113 #define WHSM_LOG_OBJECT_ALLOCATE(level_,kind_) \
114 OSAPI_LOG_ENTRY_ADD_1INT((level_),WHSM_LOG_OBJECT_ALLOCATE_EC,\
115  OSAPI_LOG_MSG_PN_X2_STD_PARAM ,"kind",(kind_))
116 
117 /*ce
118  * \brief Failed to delete object of the specified kind
119  *
120  * \ingroup WHLogCodesClass
121  */
122 #define WHSM_LOG_OBJECT_DELETE_EC (WHSM_LOG_BASE + 5)
123 #define WHSM_LOG_OBJECT_DELETE(level_,kind_) \
124 OSAPI_LOG_ENTRY_ADD_1INT((level_),WHSM_LOG_OBJECT_DELETE_EC,\
125  OSAPI_LOG_MSG_PN_X2_STD_PARAM ,"kind",(kind_))
126 
127 /*ce
128  * \brief Failed to index an object of the specified kind
129  *
130  * \ingroup WHLogCodesClass
131  */
132 #define WHSM_LOG_OBJECT_INDEX_EC (WHSM_LOG_BASE + 6)
133 #define WHSM_LOG_OBJECT_INDEX(level_,kind_) \
134 OSAPI_LOG_ENTRY_ADD_1INT((level_),WHSM_LOG_OBJECT_INDEX_EC,\
135  OSAPI_LOG_MSG_PN_X2_STD_PARAM ,"kind",(kind_))
136 
137 /*ce
138  * \brief No property when creating a writer history instance
139  *
140  * \ingroup WHLogCodesClass
141  */
142 #define WHSM_LOG_NO_PROPERTY_EC (WHSM_LOG_BASE + 7)
143 #define WHSM_LOG_NO_PROPERTY(level_) \
144 OSAPI_LOG_ENTRY_ADD((level_),WHSM_LOG_NO_PROPERTY_EC,\
145  OSAPI_LOG_MSG_PN_X2_STD_PARAM)
146 
147 #endif
148 

RTI Connext DDS Micro Version 2.4.8 Copyright © Tue Apr 12 2016 Real-Time Innovations, Inc