OpenClovis Logo

clCorMetaData.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2002-2012 OpenClovis Solutions Inc. All Rights Reserved.
3  *
4  * This file is available under a commercial license from the
5  * copyright holder or the GNU General Public License Version 2.0.
6  *
7  * The source code for this program is not published or otherwise
8  * divested of its trade secrets, irrespective of what has been
9  * deposited with the U.S. Copyright office.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * General Public License for more details.
15  *
16  * For more information, see the file COPYING provided with this
17  * material.
18  */
19 /*******************************************************************************
20  * ModuleName : cor
21  * File : clCorMetaData.h
22  *******************************************************************************/
23 
24 /*******************************************************************************
25  * Description :
26  *
27  * The file contains all the MetaData data structures.
28  *
29  *
30  *****************************************************************************/
31 
45 #ifndef _CL_COR_META_DATA_H_
46 
47 #define _CL_COR_META_DATA_H_
48 
49 #ifdef __cplusplus
50  extern "C" {
51 #endif
52 
53 #include <clCommon.h>
54 #include <clCntApi.h>
55 #include <clIocApi.h>
56 #include <clOsalApi.h>
57 
58 
59 /******************************************************************************
60  * Constant and Macro Definitions
61  *****************************************************************************/
62 
66 #define CL_COR_WTH_COOKIE_ID CL_EO_COR_SERVER_COOKIE_ID+1
67 
68 
69 #define CL_COR_VERSION_NO 0x0100
70 #define CL_COR_DEFAULT_MAX_SESSIONS 5
71 
72 #define CL_COR_DEFAULT_MAX_RETRIES 3
73 
77 #define CL_COR_DEFAULT_TIMEOUT 3000
78 
82 #define CL_COR_MAX_NAME_SZ CL_MAX_NAME_LENGTH
83 
87 #define CL_COR_NO_SAVE 0
88 #define CL_COR_SAVE_PER_TXN 1
89 #define CL_COR_PERIODIC_SAVE 2
90 #define CL_COR_DELTA_SAVE 3
91 
95 #define CL_COR_UNKNOWN_ATTRIB -1
96 
102 #define CL_COR_CLI_STR_LEN 1024
103 
104 
109 #define CL_COR_VERSION_NO 0x0100
110 #define CL_COR_HANDLE_MAX_DEPTH 20
111 #define CL_COR_INVALID_MO_ID -1
112 #define CL_COR_INVALID_MO_INSTANCE -1
113 #define CL_COR_INVALID_SVC_ID -1
114 #define CL_COR_SVC_ID_DEFAULT 0
115 
119 #define CL_COR_CLASS_WILD_CARD ((ClCorClassTypeT)0xFFFFFFFE)
120 
124 #define CL_COR_INSTANCE_WILD_CARD ((ClCorInstanceIdT) -2)
125  /* 0x7FFFFFFE */
126 #define CL_COR_SVC_WILD_CARD ((ClCorMOServiceIdT)0xFFFE)
127 
128 
132 #define CL_COR_CONT_ATTR_MAX_DEPTH 10
133 
137 #define CL_COR_INVALID_ATTR_ID -1
138 
142 #define CL_COR_INVALID_ATTR_IDX -1
143 #define CL_COR_ATTR_WILD_CARD -2
144 #define CL_COR_INDEX_WILD_CARD -2
145 
149 #define CL_COR_SIMPLE_TXN NULL
150 
151 #define CL_COR_OH_MAX_TYPES 16
152 #define CL_COR_OH_MAX_LEVELS 64
153 
157 #define CL_COR_OH_MASK_END_MARKER 0xFF
158 
167 #define CL_COR_ATTR_CONFIG 0x01000000
171 #define CL_COR_ATTR_RUNTIME 0x02000000
175 #define CL_COR_ATTR_OPERATIONAL 0x04000000
179 #define CL_COR_ATTR_WRITABLE 0x00010000
183 #define CL_COR_ATTR_INITIALIZED 0x00020000
184 
188 #define CL_COR_ATTR_CACHED 0x00000100
192 #define CL_COR_ATTR_PERSISTENT 0x00000200
193 
194 /******************************************************************************
195  * Data Types
196  *****************************************************************************/
197 
201 typedef ClInt32T ClCorClassTypeT;
202 
206 typedef ClInt32T ClCorAttrIdT;
207 
211 typedef ClInt32T ClCorInstanceIdT;
212 
216 typedef ClUint32T ClCorAttrFlagT;
217 
221 typedef ClUint32T ClCorJobStatusT;
222 
226 typedef ClHandleT ClCorBundleHandleT;
227 typedef ClHandleT* ClCorBundleHandlePtrT;
228 
229 
233 typedef enum ClCorType {
234 
235  CL_COR_INVALID_DATA_TYPE = -1,
236 
241 
246 
251 
256 
261 
266 
271 
276 
281 
288 
295 
302 
309 
316 
318 
322 typedef enum ClCorAttrType {
323 
324  CL_COR_MAX_TYPE = CL_COR_SEQUENCE32,
325 
330 
335 
340 
345 
351 
353 
359 typedef enum{
396 
403 typedef enum{
424 
432  ClInt64T init;
433 
437  ClInt64T min;
438 
442  ClInt64T max;
443 };
444 
448 typedef struct ClCorAttrValues ClCorAttrValuesT;
449 
454 
459 
463  ClUint32T maxElement;
464 
469  };
475  {
476  ClCorAttrIdT attrId;
477  ClCorAttrTypeT attrType;
478  /* union{ - NOTE: Struct made in place of Union becoz of IDL related issues. */
479  struct
480  {
481 
486 
491 
492  }u;
493  /* }u; */
494  };
495 typedef struct ClCorAttrDef ClCorAttrDefT;
496 
500 typedef ClRcT (* ClCorClassAttrWalkFunc)(ClCorClassTypeT clsId, ClCorAttrDefT *attrDef, ClPtrT cookie);
501 
513 typedef enum {
528 
533 typedef enum {
534 
535  CL_COR_LOCK_OBJECT,
536  CL_COR_LOCK_SUBTREE
537 
539 
548 typedef enum {
581 
583 
588 typedef enum {
598 
608 typedef ClPtrT ClCorObjectHandleT;
609 
610 #define CL_COR_OBJ_HANDLE_NULL NULL
611 
612 #define CL_COR_OBJ_HANDLE_INIT(objH) \
613  do \
614  { \
615  if (objH != NULL) \
616  { \
617  ClUint16T size = 0; \
618  ClRcT rc = CL_OK; \
619  ClUint8T* tempHandle = (ClUint8T *) objH; \
620  rc = clCorObjectHandleSizeGet(objH, &size); \
621  if (rc != CL_OK) \
622  return rc; \
623  tempHandle += sizeof(ClUint16T); \
624  memset((void *) tempHandle, 0, size - sizeof(ClUint16T)); \
625  } \
626  } while(0)
627 
628 #define CL_COR_OBJ_HANDLE_ISNULL(objH) (objH == NULL)
629 
637 typedef ClPtrT ClCorTxnSessionIdT;
638 
642 typedef ClPtrT ClCorTxnIdT;
643 
647 typedef ClUint32T ClCorTxnJobIdT;
648 
653 typedef enum {
654  CL_COR_OP_RESERVED = 0,
683  CL_COR_OP_ALL =
685  CL_COR_OP_SET |
687  CL_COR_OP_GET |
690 
695 typedef enum ClCorTxnJobStatus
696 {
697  CL_COR_TXN_JOB_PASS,
698  CL_COR_TXN_JOB_FAIL
700 
719 typedef enum {
720 
725 
730 
736 
741  CL_COR_OBJ_CACHE_MAX = CL_COR_OBJ_CACHE_GLOBAL,
742  CL_COR_OBJ_CACHE_MASK = 0xFF,
743 
748 
753 
758 
762  CL_COR_OBJ_FLAGS_ALL = (CL_COR_OBJ_CACHE_MASK |
766 
767 #define CL_COR_OBJ_FLAGS_DEFAULT \
768  (CL_COR_OBJ_CACHE_GLOBAL | CL_COR_OBJ_PERSIST | CL_COR_OBJ_ALLOW_SUB_TREE_DELETE)
769 
783 
784 
790 
797 
798 /*
799  * This structure ClCorCommInfo contains the communication information for COR. Used for COR
800  * communication configuration.
801  */
802 struct ClCorCommInfo {
803 
807  ClCorAddrT addr;
808 
812  ClUint32T timeout;
813 
817  ClUint16T maxRetries;
818 
822  ClUint16T maxSessions;
823 
824 };
825 
826 typedef struct ClCorCommInfo ClCorCommInfoT;
830 typedef ClCorCommInfoT* ClCorCommInfoPtrT;
831 
841 typedef enum {
842 
847 
852 
858 
859  CL_COR_MO_PATH_QUALIFIER_MAX = CL_COR_MO_PATH_RELATIVE_TO_BASE
860 
862 
873 
878 };
879 
883 typedef struct ClCorMOHandle ClCorMOHandleT;
884 
889 
890 /* TODO: Finally need to use directly ClCorServiceIdT, but the issue with
891  * enums is they occupy int space (4 bytes). So need to test and
892  * figure out
893  */
900 typedef ClInt16T ClCorMOServiceIdT;
901 
918 struct ClCorMOId {
919 
925  ClCorMOHandleT node[CL_COR_HANDLE_MAX_DEPTH];
926 
935 
939  ClUint16T depth;
940 
945 
950 };
951 
955 typedef struct ClCorMOId ClCorMOIdT;
956 
961 
966 {
971 
975  ClUint32T index;
976 
977 };
978 
983 
988 
997 {
1002 
1006  ClUint16T depth;
1007 
1011  ClUint16T tmp;
1012 };
1013 
1017 typedef struct ClCorAttrPath ClCorAttrPathT;
1018 
1023 
1029 {
1033  ClUint8T baseAttrWalk;
1034 
1038  ClUint8T contAttrWalk;
1039 
1044 
1050 
1057  ClInt32T index;
1058 
1076 
1082 
1087  ClUint32T size;
1088 
1093  void *value;
1094  };
1095 
1100 
1131 
1132 /*
1133  * Attribute path of contained object,whose attribute is being walked.
1134  * pAttrPath is NULL, if attribute are of the base object (containing object).
1135  */
1137 
1138 /*
1139  * Attribute ID.
1140  */
1142 
1143 /*
1144  * Attribute type. It can be any of the following values:
1145  * \arg \c CL_COR_SIMPLE_ATTR
1146  * \arg \c CL_COR_ARRAY_ATTR
1147  * \arg \c CL_COR_ASSOCIATION_ATTR
1148  */
1149 ClCorAttrTypeT attrType,
1150 
1151 /*
1152  * Data type of an attribute. E.g.: \c CL_COR_UINT32.
1153  * \note
1154  * For attrType \c CL_COR_ASSOCIATION_ATTR, attrDataType is \c CL_COR_INVALID_DATA_TYPE.
1155  */
1156 ClCorTypeT attrDataType,
1157 
1158 /*
1159  * Pointer to actual value of \e attrId.
1160  */
1161 void *value,
1162 
1163 /*
1164  * Size of value.
1165  */
1166 ClUint32T size,
1167 
1168 /*
1169  * Attribute additional Data.
1170  */
1171 ClCorAttrFlagT attrData,
1172 
1173 /*
1174  * Cookie passed by you.
1175  */
1176 void *cookie);
1177 
1178 /*
1179  * COR MOTree walk information.
1180  *
1181  * Provides the class Id, flags and maximum number of instances. In case of MSOs, the
1182  * maximum number of instances should be ignored.
1183  */
1184 struct ClCorMOClassTreeWalkInfo
1185 {
1186 
1190  ClCorClassTypeT classId;
1191 
1195  ClUint16T flags;
1196 
1200  ClUint32T maxInstances;
1201 };
1202 
1203 typedef struct ClCorMOClassTreeWalkInfo ClCorMOClassTreeWalkInfoT;
1204 typedef ClCorMOClassTreeWalkInfoT* ClCorMOClassTreeWalkInfoPtrT;
1205 
1213 
1217  ClCorClassTypeT node[CL_COR_HANDLE_MAX_DEPTH];
1218 
1222  ClUint32T depth;
1223 
1228 
1229 };
1230 
1231 typedef struct ClCorMOClassPath ClCorMOClassPathT;
1233 
1244 {
1264  ClUint32T jobStatus;
1265 };
1266 
1270 typedef struct ClCorTxnInfo ClCorTxnInfoT;
1271 
1276 
1277 /*
1278  * Operations used while storing and retrieving the failed jobs in/from the container.
1279  */
1280 
1281 typedef enum ClCorTxnEntryId
1282 {
1283  CL_COR_TXN_INFO_ADD,
1284  CL_COR_TXN_INFO_FIRST_GET,
1285  CL_COR_TXN_INFO_NEXT_GET,
1286  CL_COR_TXN_INFO_CLEAN
1287 }ClCorTxnEntryIdT;
1288 
1289 /*
1290  * The data that is used to form the key while storing the
1291  * failed jobs into the container
1292  */
1293 struct ClCorTxnInfoStore
1294 {
1295  ClCorTxnEntryIdT op;
1296 
1297  ClCorTxnSessionIdT txnSessionId;
1298 
1299  ClCorTxnInfoT txnInfo;
1300 };
1301 
1302 typedef struct ClCorTxnInfoStore ClCorTxnInfoStoreT;
1303 typedef ClCorTxnInfoStoreT* ClCorTxnInfoStorePtrT;
1304 
1309 {
1314 
1319 
1323  ClInt32T index;
1324 
1328  ClPtrT bufferPtr;
1329 
1333  ClInt32T bufferSize;
1334 };
1335 
1340 
1345 
1350 {
1354  ClUint32T numOfValues;
1355 
1360 };
1361 
1366 
1371 
1376 {
1388  ClInt32T index;
1392  ClPtrT bufferPtr;
1396  ClInt32T bufferSize;
1401 };
1402 
1407 
1412 
1418 {
1422  ClUint32T numOfDescriptor;
1423 
1428 };
1429 
1434 
1439 
1464  ClUint32T numOfAttrDesc;
1469 };
1470 
1473 
1474 
1479 {
1484 };
1485 
1486 typedef struct ClCorBundleConfig ClCorBundleConfigT;
1488 
1489 
1507 typedef ClRcT (*ClCorObjectWalkFunT)(void * data, void *cookie);
1508 
1512 typedef ClRcT (*clCorXdrMarshallFP)(void *pGenVar, ClBufferHandleT msg, ClUint32T isDelete);
1513 
1517 typedef ClRcT (*clCorXdrUnmarshallFP)(ClBufferHandleT msg, void *pGenVar);
1518 
1545 typedef ClRcT (*ClCorBundleCallbackPtrT) (ClCorBundleHandleT bundleHandle, ClPtrT userArg);
1546 
1547 
1548 #ifdef __cplusplus
1549 }
1550 #endif
1551 #endif /* _CL_COR_META_DATA_H_ */
1552 
1553 
Typical defines found in any software project.
Header file of Clovis Container Related APIs.
Header file of Ioc Data Structures and APIs.
Operating System Abstraction Layer API.
ClPtrT ClBufferHandleT
The type of the handle for the buffer messages.
Definition: clBufferApi.h:82
ClUint32T ClRcT
Clovis return code type.
Definition: clCommon.h:168
ClCorObjWalkFlagsT
This enumeration type contains the walk related definitions.
Definition: clCorMetaData.h:548
enum ClCorType ClCorTypeT
The ClCorType enumeration contains the basic COR data types.
ClCorBundleOperationType
Type of the bundle operation.
Definition: clCorMetaData.h:773
ClUint32T ClCorJobStatusT
Status of each failed job.
Definition: clCorMetaData.h:221
ClRcT(* ClCorObjAttrWalkFuncT)(ClCorAttrPathPtrT pAttrPath, ClCorAttrIdT attrId, ClCorAttrTypeT attrType, ClCorTypeT attrDataType, void *value, ClUint32T size, ClCorAttrFlagT attrData, void *cookie)
The type of the callback API that is invoked for every attribute within a COR object,...
Definition: clCorMetaData.h:1130
ClCorAttributeValueT * ClCorAttributeValuePtrT
Pointer type for ClCorAttributeValueT.
Definition: clCorMetaData.h:1344
enum ClCorAttrType ClCorAttrTypeT
The values of this enumeration type refer to the COR attribute types.
ClPtrT ClCorObjectHandleT
The structure ClCorObjectHandle is the handle to MO.
Definition: clCorMetaData.h:608
ClCorMoIdClassGetFlagsT
The values of the ClCorMoIdClassGetFlagsT enumeration type will be used in the clCorMoIdToClassGet() ...
Definition: clCorMetaData.h:588
ClCorAttrValueDescriptorT * ClCorAttrValueDescriptorPtrT
Pointer type for ClCorAttrValueDescriptorT.
Definition: clCorMetaData.h:1411
ClCorAttrCmpFlagT
The enumeration ClCorAttrCmpFlagT contains the comparison flags used to compare the attribute values ...
Definition: clCorMetaData.h:359
ClInt32T ClCorClassTypeT
The type of an identifier for the COR class.
Definition: clCorMetaData.h:201
ClCorType
The ClCorType enumeration contains the basic COR data types.
Definition: clCorMetaData.h:233
ClPtrT ClCorTxnIdT
The type of the COR transaction ID used to identify a transaction session.
Definition: clCorMetaData.h:642
ClCorAddrT * ClCorAddrPtrT
A pointer to the IOC physical address structure.
Definition: clCorMetaData.h:796
ClCorObjFlagsT
MO and MSO related flags Following flags are used to specify:
Definition: clCorMetaData.h:719
ClCorAttrType
The values of this enumeration type refer to the COR attribute types.
Definition: clCorMetaData.h:322
ClCorOpsT
The values of the ClCorOpsT enumeration type contain the Operation IDs.
Definition: clCorMetaData.h:653
ClInt32T ClCorAttrIdT
The type of an identifier for a COR attribute.
Definition: clCorMetaData.h:206
ClCorObjTypesT
This type used to know the type of object the object-handle contains.
Definition: clCorMetaData.h:513
ClPtrT ClCorTxnSessionIdT
The type of the handle of a COR transaction session.
Definition: clCorMetaData.h:637
ClCorCommInfoT * ClCorCommInfoPtrT
The type of the pointer for COR communication configuration.
Definition: clCorMetaData.h:830
ClCorAttrPathT * ClCorAttrPathPtrT
The pointer to ClCorAttrPathT.
Definition: clCorMetaData.h:1022
#define CL_COR_CONT_ATTR_MAX_DEPTH
Constants related to ClCorAttrPath.
Definition: clCorMetaData.h:132
ClHandleT ClCorBundleHandleT
Type definition of the bundle handle.
Definition: clCorMetaData.h:226
enum ClCorTxnJobStatus ClCorTxnJobStatusT
To set the status of a job given in the transaction.
ClCorMOHandleT * ClCorMOHandlePtrT
Pointer type definition for ClCorMOHandleT.
Definition: clCorMetaData.h:888
ClIocPhysicalAddressT ClCorAddrT
This type definition contains the IOC physical address and the port address of the component that reg...
Definition: clCorMetaData.h:789
ClRcT(* clCorXdrUnmarshallFP)(ClBufferHandleT msg, void *pGenVar)
IDL UnMarshall Function Prototype.
Definition: clCorMetaData.h:1517
ClRcT(* ClCorClassAttrWalkFunc)(ClCorClassTypeT clsId, ClCorAttrDefT *attrDef, ClPtrT cookie)
Attribute Walk function prototype.
Definition: clCorMetaData.h:500
ClRcT(* ClCorObjectWalkFunT)(void *data, void *cookie)
Type of callback function used for Object Walk.
Definition: clCorMetaData.h:1507
ClCorMoPathQualifierT
This enumeration is also part of the ClCorMOIdT structure.
Definition: clCorMetaData.h:841
ClCorMOIdT * ClCorMOIdPtrT
A pointer type to ClCorMOIdT.
Definition: clCorMetaData.h:960
ClRcT(* clCorXdrMarshallFP)(void *pGenVar, ClBufferHandleT msg, ClUint32T isDelete)
IDL Marshall Function Prototype.
Definition: clCorMetaData.h:1512
ClUint32T ClCorTxnJobIdT
The type of COR transaction Job Id, used to identify a job uniquely within a transaction.
Definition: clCorMetaData.h:647
ClCorAttrIdIdxPairT * ClCorAttrIdIdxPairPtr
Pointer type definition for ClCorAttrIdIdxPairT.
Definition: clCorMetaData.h:987
ClCorTxnJobStatus
To set the status of a job given in the transaction.
Definition: clCorMetaData.h:696
ClInt16T ClCorMOServiceIdT
This type is part of the ClCorMOIdT type to access a MO or MSO.
Definition: clCorMetaData.h:900
ClRcT(* ClCorBundleCallbackPtrT)(ClCorBundleHandleT bundleHandle, ClPtrT userArg)
The callback function for the asynchronous bunlde.
Definition: clCorMetaData.h:1545
ClCorAttrWalkOpT
The enumeration ClCorAttrWalkOpT contains the various options for walk operation on the attributes.
Definition: clCorMetaData.h:403
ClCorAttributeValueListT * ClCorAttributeValueListPtrT
Pointer type for ClCorAttributeValueListT.
Definition: clCorMetaData.h:1370
ClInt32T ClCorInstanceIdT
The type of an identifier for a COR instance.
Definition: clCorMetaData.h:211
ClCorAttrValueDescriptorListT * ClCorAttrValueDescriptorListPtrT
Pointer type to ClCorAttrValueDescriptorListT.
Definition: clCorMetaData.h:1438
ClCorObjLockFlagsT
Lock related definitions.
Definition: clCorMetaData.h:533
enum ClCorBundleOperationType ClCorBundleOperationTypeT
Type of the bundle operation.
ClUint32T ClCorAttrFlagT
Typedef for storing the attribute flags.
Definition: clCorMetaData.h:216
ClCorTxnInfoT * ClCorTxnInfoPtrT
Pointer type definition for ClCorTxnInfoT.
Definition: clCorMetaData.h:1275
@ CL_COR_MO_SUBTREE_WALK
This is to walk the mo-subtree below a given root.
Definition: clCorMetaData.h:567
@ CL_COR_MO_WALK
The walk is performed through the object tree and returns the MOs below the root MoId that satisfies ...
Definition: clCorMetaData.h:557
@ CL_COR_MOTREE_WALK
Walks the MO Tree.
Definition: clCorMetaData.h:552
@ CL_COR_MSO_WALK
Returns the object handle of all the MSO objects below the root MOId that satisfies the filter criter...
Definition: clCorMetaData.h:562
@ CL_COR_MO_WALK_UP
Walk the MO objects in the object tree upwards.
Definition: clCorMetaData.h:576
@ CL_COR_MSO_SUBTREE_WALK
This is to walk the mso-subtree below a given root.
Definition: clCorMetaData.h:572
@ CL_COR_MSO_WALK_UP
Walk the MSO objects in the object tree upwards.
Definition: clCorMetaData.h:580
@ CL_COR_BUNDLE_TRANSACTIONAL
Bundle type is transactional- for set/create/delete.
Definition: clCorMetaData.h:777
@ CL_COR_BUNDLE_NON_TRANSACTIONAL
Bundle type is non-transactional.
Definition: clCorMetaData.h:781
@ CL_COR_MO_CLASS_GET
If the MO class of the MOID is needed.
Definition: clCorMetaData.h:592
@ CL_COR_MSO_CLASS_GET
If the MSO class of the MOID is needed.
Definition: clCorMetaData.h:596
@ CL_COR_ATTR_CMP_FLAG_VALUE_GREATER_THAN
All the MOs whose attribute value of the attribute is less than the value specified are returned.
Definition: clCorMetaData.h:384
@ CL_COR_ATTR_CMP_FLAG_VALUE_LESS_THAN
All the MO whose attribute value of the attribute is greater than than the value specified are return...
Definition: clCorMetaData.h:374
@ CL_COR_ATTR_CMP_FLAG_MAX
Maximum value of the attribute flag.
Definition: clCorMetaData.h:394
@ CL_COR_ATTR_CMP_FLAG_VALUE_LESS_OR_EQUALS
All the MO whose attribute value of the attribute is greater and equal to the value specified are ret...
Definition: clCorMetaData.h:379
@ CL_COR_ATTR_CMP_FLAG_INVALID
The comparison flag is invalid.
Definition: clCorMetaData.h:364
@ CL_COR_ATTR_CMP_FLAG_VALUE_EQUAL_TO
Only the MO with attribute value equal to the value specified is(are) returned.
Definition: clCorMetaData.h:369
@ CL_COR_ATTR_CMP_FLAG_VALUE_GREATER_OR_EQUALS
All the MOs whose attribute value of the attribute is less than and equal to the value specified are ...
Definition: clCorMetaData.h:389
@ CL_COR_INT8
Character data type.
Definition: clCorMetaData.h:245
@ CL_COR_DOUBLE
Double data type.
Definition: clCorMetaData.h:294
@ CL_COR_COUNTER64
Counter a 64-bits data type.
Definition: clCorMetaData.h:308
@ CL_COR_UINT16
Unsigned short.
Definition: clCorMetaData.h:260
@ CL_COR_UINT64
Unsigned long long data type.
Definition: clCorMetaData.h:280
@ CL_COR_UINT8
Unsigned character.
Definition: clCorMetaData.h:250
@ CL_COR_FLOAT
Float data type.
Definition: clCorMetaData.h:287
@ CL_COR_INT32
Integer data type.
Definition: clCorMetaData.h:265
@ CL_COR_COUNTER32
Counter data type.
Definition: clCorMetaData.h:301
@ CL_COR_UINT32
Unsigned integer data type.
Definition: clCorMetaData.h:270
@ CL_COR_INT64
Long long data type.
Definition: clCorMetaData.h:275
@ CL_COR_INT16
Short data type.
Definition: clCorMetaData.h:255
@ CL_COR_VOID
Void data type.
Definition: clCorMetaData.h:240
@ CL_COR_SEQUENCE32
Sequence number data type.
Definition: clCorMetaData.h:315
@ CL_COR_OBJ_PERSIST
This flag can be made optional with one cached flag.
Definition: clCorMetaData.h:747
@ CL_COR_OBJ_CACHE_ONLY_ON_MASTER
Object copy exists only on the MASTER.
Definition: clCorMetaData.h:729
@ CL_COR_OBJ_CACHE_GLOBAL
Object copy exists on every active COR.
Definition: clCorMetaData.h:740
@ CL_COR_OBJ_CACHE_ON_MASTER
Object copy exists on MASTER (e.g., SD) and on the blade to which it belongs.
Definition: clCorMetaData.h:735
@ CL_COR_OBJ_DO_NOT_PUBLISH
This flag can be made optional with one cached flag.
Definition: clCorMetaData.h:752
@ CL_COR_OBJ_CACHE_LOCAL
Object copy exists only on the blade.
Definition: clCorMetaData.h:724
@ CL_COR_OBJ_FLAGS_ALL
This flag can be made optional with one cached flags.
Definition: clCorMetaData.h:762
@ CL_COR_OBJ_ALLOW_SUB_TREE_DELETE
This flag can be made optional with one cached flag.
Definition: clCorMetaData.h:757
@ CL_COR_CONTAINMENT_ATTR
Containment type.
Definition: clCorMetaData.h:339
@ CL_COR_SIMPLE_ATTR
Simple data type.
Definition: clCorMetaData.h:329
@ CL_COR_VIRTUAL_ATTR
Virtual type.
Definition: clCorMetaData.h:350
@ CL_COR_ASSOCIATION_ATTR
Association type.
Definition: clCorMetaData.h:344
@ CL_COR_ARRAY_ATTR
Array data type.
Definition: clCorMetaData.h:334
@ CL_COR_OP_GET
Operation type is get.
Definition: clCorMetaData.h:674
@ CL_COR_OP_SET
Operation type is set.
Definition: clCorMetaData.h:664
@ CL_COR_OP_ALL
Combination of all of operation types.
Definition: clCorMetaData.h:683
@ CL_COR_OP_DELETE
Operation type is delete.
Definition: clCorMetaData.h:669
@ CL_COR_OP_CREATE_AND_SET
Operation type is create and set.
Definition: clCorMetaData.h:679
@ CL_COR_OP_CREATE
Operation type is create.
Definition: clCorMetaData.h:659
@ CL_COR_OBJ_TYPE_SIMPLE
The object type is simple.
Definition: clCorMetaData.h:518
@ CL_COR_OBJ_TYPE_MO
To get the MO object given the object handle.
Definition: clCorMetaData.h:522
@ CL_COR_OBJ_TYPE_MSO
To get the MSO object given the object handle.
Definition: clCorMetaData.h:526
@ CL_COR_MO_PATH_ABSOLUTE
Signifies that the path is absolute, equivalent to Unix '/'.
Definition: clCorMetaData.h:846
@ CL_COR_MO_PATH_RELATIVE_TO_BASE
Signifies that the path is relative to blade position in the COR hierarchy.
Definition: clCorMetaData.h:857
@ CL_COR_MO_PATH_RELATIVE
Signifies that the path is relative.
Definition: clCorMetaData.h:851
@ CL_COR_ATTR_WALK_ONLY_MATCHED_ATTR
The flag which specifies COR to return only the attributes matching the search criteria.
Definition: clCorMetaData.h:418
@ CL_COR_ATTR_INVALID_OPTION
This should be given when the attribute walk option is not required.
Definition: clCorMetaData.h:408
@ CL_COR_ATTR_WALK_MAX
This is just an enum delimiter.
Definition: clCorMetaData.h:422
@ CL_COR_ATTR_WALK_ALL_ATTR
The flag which indicate COR to return all the attributes of the MO matching the filter.
Definition: clCorMetaData.h:413
Version Information for various services.
Definition: clCommon.h:250
Structure capturing initialization, minimum and maximum value of simple attribute.
Definition: clCorMetaData.h:428
ClInt64T min
Minimum value of the attribute.
Definition: clCorMetaData.h:437
ClInt64T init
Default value of the attribute.
Definition: clCorMetaData.h:432
ClInt64T max
Maximum value of the attribute.
Definition: clCorMetaData.h:442
Structure for complex attribute types like Association, Array and Containment.
Definition: clCorMetaData.h:453
ClCorTypeT arrDataType
The data type for array attributes, for instance, integer array with ten elements.
Definition: clCorMetaData.h:458
ClCorClassTypeT classId
Associated or Contained class type.
Definition: clCorMetaData.h:468
ClUint32T maxElement
Maximum number of elements in Array, Contained or Association attributes.
Definition: clCorMetaData.h:463
Attribute Definition structure.
Definition: clCorMetaData.h:475
ClCorAttrValuesT simpleAttrVals
Applicable only to 8, 16 and 32-bit integers.
Definition: clCorMetaData.h:485
ClCorAttrAdditionalInfoT attrInfo
Additional attribute information (for Array, Containment, Associtation attribute type....
Definition: clCorMetaData.h:490
Managed Object handle.
Definition: clCorMetaData.h:868
ClCorInstanceIdT instance
Instance Id.
Definition: clCorMetaData.h:877
ClCorClassTypeT type
Class Id.
Definition: clCorMetaData.h:872
The structure ClCorMOId contains MoId of the object, which is the address of the COR object.
Definition: clCorMetaData.h:918
ClUint16T depth
Depth of MoId.
Definition: clCorMetaData.h:939
ClCorMOServiceIdT svcId
Service ID.
Definition: clCorMetaData.h:934
ClVersionT version
Version information.
Definition: clCorMetaData.h:949
ClCorMoPathQualifierT qualifier
Handle qualifier.This must contain the value, CL_COR_MO_PATH_ABSOLUTE.
Definition: clCorMetaData.h:944
ClCorMOHandleT node[CL_COR_HANDLE_MAX_DEPTH]
MO Handle address.
Definition: clCorMetaData.h:925
Attribute ID and index pair.
Definition: clCorMetaData.h:966
ClUint32T index
Attribute index.
Definition: clCorMetaData.h:975
ClCorAttrIdT attrId
Attribute Id.
Definition: clCorMetaData.h:970
The structure ClCorAttrPath contains the path-list of the attribute.
Definition: clCorMetaData.h:997
ClCorAttrIdIdxPairT node[CL_COR_CONT_ATTR_MAX_DEPTH]
AttrId and Index pair array.
Definition: clCorMetaData.h:1001
ClUint16T depth
Depth of the path.
Definition: clCorMetaData.h:1006
ClUint16T tmp
This 16 bits is used for padding.
Definition: clCorMetaData.h:1011
The structure ClCorObjAttrWalkFilter is used to specify filter properties while performing attribute ...
Definition: clCorMetaData.h:1029
ClUint8T contAttrWalk
This is a depricated feature and must be CL_FALSE for attribute walk.
Definition: clCorMetaData.h:1038
ClCorAttrCmpFlagT cmpFlag
The comparison flag is used to compare an attribute ID against a specified value.
Definition: clCorMetaData.h:1075
ClUint8T baseAttrWalk
This is a depreciated feature and must be CL_TRUE for attribute walk.
Definition: clCorMetaData.h:1033
ClCorAttrIdT attrId
This must contain either a valid attribute ID or CL_COR_INVALID_ATTR_ID.
Definition: clCorMetaData.h:1049
ClInt32T index
It is used to specify the index for ARRAY attributes.
Definition: clCorMetaData.h:1057
ClCorAttrWalkOpT attrWalkOption
The attrWalkOption can be set to CL_COR_ATTR_WALK_ALL_ATTR or CL_COR_ATTR_WALK_ONLY_MATCHED_ATTR.
Definition: clCorMetaData.h:1081
ClCorAttrPathT * pAttrPath
This is a depricated feature and must be NULL for attribute walk.
Definition: clCorMetaData.h:1043
void * value
Pointer to the value.
Definition: clCorMetaData.h:1093
ClUint32T size
Size of the value.
Definition: clCorMetaData.h:1087
The structure ClCorMOClassPath contains the COR object handle.
Definition: clCorMetaData.h:1212
ClUint32T depth
Depth of COR address.
Definition: clCorMetaData.h:1222
ClCorClassTypeT node[CL_COR_HANDLE_MAX_DEPTH]
COR address.
Definition: clCorMetaData.h:1217
ClCorMoPathQualifierT qualifier
Handle qualifier.
Definition: clCorMetaData.h:1227
COR Txn Failed Job Information.
Definition: clCorMetaData.h:1244
ClCorMOIdT moId
MoId of the failed Job.
Definition: clCorMetaData.h:1252
ClCorOpsT opType
Operation type that is SET, CREATE or DELETE.
Definition: clCorMetaData.h:1248
ClCorAttrPathT attrPath
Containment Path of the failed Job.
Definition: clCorMetaData.h:1256
ClUint32T jobStatus
Transaction failed job id.
Definition: clCorMetaData.h:1264
ClCorAttrIdT attrId
Attribute Id of the failed job.
Definition: clCorMetaData.h:1260
Type to provide value for the initialized attributes.
Definition: clCorMetaData.h:1309
ClCorAttrPathPtrT pAttrPath
Attribute Path.
Definition: clCorMetaData.h:1313
ClInt32T index
Index of the attribute.
Definition: clCorMetaData.h:1323
ClInt32T bufferSize
Size of the buffer.
Definition: clCorMetaData.h:1333
ClCorAttrIdT attrId
Attribute Identifier.
Definition: clCorMetaData.h:1318
ClPtrT bufferPtr
Pointer to the buffer which contain the data.
Definition: clCorMetaData.h:1328
Type to provide the list of attribute values for initialized attributes.
Definition: clCorMetaData.h:1350
ClCorAttributeValuePtrT pAttributeValue
List of attribute values.
Definition: clCorMetaData.h:1359
ClUint32T numOfValues
Number of attribute values.
Definition: clCorMetaData.h:1354
Structure to attribute job which will be added to the bundle.
Definition: clCorMetaData.h:1376
ClCorAttrPathPtrT pAttrPath
Pointer to the attribute path.
Definition: clCorMetaData.h:1380
ClInt32T bufferSize
Size of the buffer pointed by bufferPtr.
Definition: clCorMetaData.h:1396
ClInt32T index
Index of the array attribute.
Definition: clCorMetaData.h:1388
ClCorJobStatusT * pJobStatus
Status of the job.
Definition: clCorMetaData.h:1400
ClCorAttrIdT attrId
Attribute Identifier.
Definition: clCorMetaData.h:1384
ClPtrT bufferPtr
Pointer to the buffer which contain the data.
Definition: clCorMetaData.h:1392
Type for the attribute value list.
Definition: clCorMetaData.h:1418
ClUint32T numOfDescriptor
Number of Attribute Descriptor.
Definition: clCorMetaData.h:1422
ClCorAttrValueDescriptorPtrT pAttrDescriptor
Pointer to the list of attribute descriptors.
Definition: clCorMetaData.h:1427
Structure to store read job data.
Definition: clCorMetaData.h:1445
ClCorObjectHandleT * objHandle
Pointer to the object handle.
Definition: clCorMetaData.h:1451
ClCorMOIdPtrT pMoId
Pointer to the MOID.
Definition: clCorMetaData.h:1455
ClCorOpsT opType
Operation type which will take one of the following: CL_COR_OP_CREATE, CL_COR_OP_SET,...
Definition: clCorMetaData.h:1460
ClCorAttrValueDescriptorPtrT pAttrDesc
Array of attribute descriptors.
Definition: clCorMetaData.h:1468
ClUint32T numOfAttrDesc
Number of job attribute descriptors.
Definition: clCorMetaData.h:1464
Structure for storing the bundle configuration.
Definition: clCorMetaData.h:1479
ClCorBundleOperationTypeT bundleType
Type of bundle.
Definition: clCorMetaData.h:1483
The IOC Physical address of an application's communication end point.
Definition: clIocApi.h:383

Generated on Tue Jan 10 10:29:15 PST 2012 for OpenClovis SDK using Doxygen