"OpenClovis SAFplus SDK" SAFplus Platform API Reference Guide

Header file of all MetaData data structures. More...

#include <clCommon.h>
#include <clCntApi.h>
#include <clIocApi.h>
#include <clOsalApi.h>

Classes
struct	ClCorAttrAdditionalInfo
	Structure for complex attribute types like Association, Array and Containment. More...
struct	ClCorAttrDef
	Attribute Definition structure. More...
struct	ClCorAttributeValue
	Type to provide value for the initialized attributes. More...
struct	ClCorAttributeValueList
	Type to provide the list of attribute values for initialized attributes. More...
struct	ClCorAttrIdIdxPair
	Attribute ID and index pair. More...
struct	ClCorAttrPath
	The structure ClCorAttrPath contains the path-list of the attribute. More...
struct	ClCorAttrValueDescriptor
	Structure to attribute job which will be added to the bundle. More...
struct	ClCorAttrValueDescriptorList
	Type for the attribute value list. More...
struct	ClCorAttrValues
	Structure capturing initialization, minimum and maximum value of simple attribute. More...
struct	ClCorBundleConfig
	Structure for storing the bundle configuration. More...
struct	ClCorJobDescriptor
	Structure to store read job data. More...
struct	ClCorMOClassPath
	The structure ClCorMOClassPath contains the COR object handle. More...
struct	ClCorMOHandle
	Managed Object handle. More...
struct	ClCorMOId
	The structure ClCorMOId contains MoId of the object, which is the address of the COR object. More...
struct	ClCorObjAttrWalkFilter
	The structure ClCorObjAttrWalkFilter is used to specify filter properties while performing attribute walk operation. More...
struct	ClCorTxnInfo
	COR Txn Failed Job Information. More...

Macros
#define	CL_COR_ATTR_CACHED 0x00000100
	Attribute type is cached (stored in RAM in COR)
#define	CL_COR_ATTR_CONFIG 0x01000000
	Macros for defining the attribute flags.
#define	CL_COR_ATTR_INITIALIZED 0x00020000
	Attribute type is intialized (upon creation, assign a default value – MUST use clCorObjectCreateAndSet to create)
#define	CL_COR_ATTR_OPERATIONAL 0x04000000
	Not IMPLEMENTED.
#define	CL_COR_ATTR_PERSISTENT 0x00000200
	Attribute type is persistent.
#define	CL_COR_ATTR_RUNTIME 0x02000000
	Attribute type is runtime (NOT stored in database).
#define	CL_COR_ATTR_WRITABLE 0x00010000
	Attribute type is writeable.
#define	CL_COR_CLASS_WILD_CARD ((ClCorClassTypeT)0xFFFFFFFE)
	Wild Card Class Id.
#define	CL_COR_CLI_STR_LEN 1024
	String length for cli commands.
#define	CL_COR_CONT_ATTR_MAX_DEPTH 10
	Constants related to ClCorAttrPath.
#define	CL_COR_DEFAULT_TIMEOUT 3000
	This value is 3 seconds.
#define	CL_COR_INSTANCE_WILD_CARD 0xFFFFFFFE
	Wild Card Instance Id.
#define	CL_COR_INVALID_ATTR_ID -1
	Invalid Attribute Id.
#define	CL_COR_INVALID_ATTR_IDX -1
	Invalid Attribute Index.
#define	CL_COR_MAX_NAME_SZ CL_MAX_NAME_LENGTH
	Maximum size of Name for Class, Attributes.
#define	CL_COR_NO_SAVE 0
	Persistency related Macros.
#define	CL_COR_OH_MASK_END_MARKER 0xFF
	End Marker for a OH Mask.
#define	CL_COR_SIMPLE_TXN NULL
	Simple transaction with only one job.
#define	CL_COR_UNKNOWN_ATTRIB -1
	Invalid attribute.
#define	CL_COR_VERSION_NO 0x0100
	Currently not supported.
#define	CL_COR_VERSION_NO 0x0100
	Currently not supported.
#define	CL_COR_WTH_COOKIE_ID CL_EO_COR_SERVER_COOKIE_ID+1
	CookieId of COR client for transaction forwarding.

Typedefs
typedef ClCorAddrT *	ClCorAddrPtrT
	A pointer to the IOC physical address structure.
typedef ClIocPhysicalAddressT	ClCorAddrT
	This type definition contains the IOC physical address and the port address of the component that registers itself as an OI for a MO.
typedef ClUint32T	ClCorAttrFlagT
	Typedef for storing the attribute flags.
typedef ClCorAttributeValueListT *	ClCorAttributeValueListPtrT
	Pointer type for ClCorAttributeValueListT.
typedef struct ClCorAttributeValueList	ClCorAttributeValueListT
	Type definition for ClCorAttributeValueList.
typedef ClCorAttributeValueT *	ClCorAttributeValuePtrT
	Pointer type for ClCorAttributeValueT.
typedef struct ClCorAttributeValue	ClCorAttributeValueT
	Type definition for ClCorAttributeValue.
typedef ClCorAttrIdIdxPairT *	ClCorAttrIdIdxPairPtr
	Pointer type definition for ClCorAttrIdIdxPairT.
typedef struct ClCorAttrIdIdxPair	ClCorAttrIdIdxPairT
	Type definition for ClCorAttrIdIdxPair.
typedef ClInt32T	ClCorAttrIdT
	The type of an identifier for a COR attribute.
typedef ClCorAttrPathT *	ClCorAttrPathPtrT
	The pointer to ClCorAttrPathT.
typedef struct ClCorAttrPath	ClCorAttrPathT
	Type definition for ClCorAttrPath.
typedef enum ClCorAttrType	ClCorAttrTypeT
	The values of this enumeration type refer to the COR attribute types.
typedef ClCorAttrValueDescriptorListT *	ClCorAttrValueDescriptorListPtrT
	Pointer type to ClCorAttrValueDescriptorListT.
typedef struct ClCorAttrValueDescriptorList	ClCorAttrValueDescriptorListT
	Type definition for ClCorAttrValueDescriptorList.
typedef ClCorAttrValueDescriptorT *	ClCorAttrValueDescriptorPtrT
	Pointer type for ClCorAttrValueDescriptorT.
typedef struct ClCorAttrValueDescriptor	ClCorAttrValueDescriptorT
	Type definition for ClCorAttrValueDescriptor.
typedef struct ClCorAttrValues	ClCorAttrValuesT
	Type definition for ClCorAttrValues.
typedef ClRcT(*	ClCorBundleCallbackPtrT )(ClCorBundleHandleT bundleHandle, ClPtrT userArg)
	The callback function for the asynchronous bunlde.
typedef ClHandleT	ClCorBundleHandleT
	Type definition of the bundle handle.
typedef enum ClCorBundleOperationType	ClCorBundleOperationTypeT
	Type of the bundle operation.
typedef ClRcT(*	ClCorClassAttrWalkFunc )(ClCorClassTypeT clsId, ClCorAttrDefT *attrDef, ClPtrT cookie)
	Attribute Walk function prototype.
typedef ClInt32T	ClCorClassTypeT
	The type of an identifier for the COR class.
typedef ClCorCommInfoT *	ClCorCommInfoPtrT
	The type of the pointer for COR communication configuration.
typedef ClInt32T	ClCorInstanceIdT
	The type of an identifier for a COR instance.
typedef ClUint32T	ClCorJobStatusT
	Status of each failed job.
typedef ClCorMOHandleT *	ClCorMOHandlePtrT
	Pointer type definition for ClCorMOHandleT.
typedef struct ClCorMOHandle	ClCorMOHandleT
	Type definition for ClCorMOHandle.
typedef ClCorMOIdT *	ClCorMOIdPtrT
	A pointer type to ClCorMOIdT.
typedef struct ClCorMOId	ClCorMOIdT
	Type definition for ClCorMOId.
typedef ClInt16T	ClCorMOServiceIdT
	This type is part of the ClCorMOIdT type to access a MO or MSO.
typedef struct ClCorObjAttrWalkFilter	ClCorObjAttrWalkFilterT
	Typedef for ClCorObjAttrWalkFilter.
typedef 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, during the walk operation.
typedef ClPtrT	ClCorObjectHandleT
	The structure ClCorObjectHandle is the handle to MO.
typedef ClRcT(*	ClCorObjectWalkFunT )(void data, void cookie)
	Type of callback function used for Object Walk.
typedef ClPtrT	ClCorTxnIdT
	The type of the COR transaction ID used to identify a transaction session.
typedef ClCorTxnInfoT *	ClCorTxnInfoPtrT
	Pointer type definition for ClCorTxnInfoT.
typedef struct ClCorTxnInfo	ClCorTxnInfoT
	Type definition for ClCorTxnInfo.
typedef ClUint32T	ClCorTxnJobIdT
	The type of COR transaction Job Id, used to identify a job uniquely within a transaction.
typedef enum ClCorTxnJobStatus	ClCorTxnJobStatusT
	To set the status of a job given in the transaction.
typedef ClPtrT	ClCorTxnSessionIdT
	The type of the handle of a COR transaction session.
typedef enum ClCorType	ClCorTypeT
	The ClCorType enumeration contains the basic COR data types.
typedef ClRcT(*	clCorXdrMarshallFP )(void *pGenVar, ClBufferHandleT msg, ClUint32T isDelete)
	IDL Marshall Function Prototype.
typedef ClRcT(*	clCorXdrUnmarshallFP )(ClBufferHandleT msg, void *pGenVar)
	IDL UnMarshall Function Prototype.

Enumerations
enum	ClCorAttrCmpFlagT { CL_COR_ATTR_CMP_FLAG_INVALID = 0, CL_COR_ATTR_CMP_FLAG_VALUE_EQUAL_TO, CL_COR_ATTR_CMP_FLAG_VALUE_LESS_THAN, CL_COR_ATTR_CMP_FLAG_VALUE_LESS_OR_EQUALS, CL_COR_ATTR_CMP_FLAG_VALUE_GREATER_THAN, CL_COR_ATTR_CMP_FLAG_VALUE_GREATER_OR_EQUALS, CL_COR_ATTR_CMP_FLAG_MAX }
	The enumeration ClCorAttrCmpFlagT contains the comparison flags used to compare the attribute values with a specified value. More...
enum	ClCorAttrType { , CL_COR_SIMPLE_ATTR, CL_COR_ARRAY_ATTR, CL_COR_CONTAINMENT_ATTR, CL_COR_ASSOCIATION_ATTR, CL_COR_VIRTUAL_ATTR }
	The values of this enumeration type refer to the COR attribute types. More...
enum	ClCorAttrWalkOpT { CL_COR_ATTR_INVALID_OPTION = 0, CL_COR_ATTR_WALK_ALL_ATTR, CL_COR_ATTR_WALK_ONLY_MATCHED_ATTR, CL_COR_ATTR_WALK_MAX }
	The enumeration ClCorAttrWalkOpT contains the various options for walk operation on the attributes. More...
enum	ClCorBundleOperationType { CL_COR_BUNDLE_TRANSACTIONAL = 1, CL_COR_BUNDLE_NON_TRANSACTIONAL }
	Type of the bundle operation. More...
enum	ClCorMoIdClassGetFlagsT { CL_COR_MO_CLASS_GET, CL_COR_MSO_CLASS_GET }
	The values of the ClCorMoIdClassGetFlagsT enumeration type will be used in the clCorMoIdToClassGet() API. More...
enum	ClCorMoPathQualifierT { CL_COR_MO_PATH_ABSOLUTE = 0, CL_COR_MO_PATH_RELATIVE, CL_COR_MO_PATH_RELATIVE_TO_BASE }
	This enumeration is also part of the ClCorMOIdT structure. More...
enum	ClCorObjFlagsT { CL_COR_OBJ_CACHE_LOCAL = 0x1, CL_COR_OBJ_CACHE_ONLY_ON_MASTER = 0x2, CL_COR_OBJ_CACHE_ON_MASTER = 0x4, CL_COR_OBJ_CACHE_GLOBAL = 0x8 , CL_COR_OBJ_PERSIST = 0x100, CL_COR_OBJ_DO_NOT_PUBLISH = 0x200, CL_COR_OBJ_ALLOW_SUB_TREE_DELETE = 0x400, CL_COR_OBJ_FLAGS_ALL }
	MO and MSO related flags Following flags are used to specify: More...
enum	ClCorObjLockFlagsT
	Lock related definitions.
enum	ClCorObjTypesT { CL_COR_OBJ_TYPE_SIMPLE, CL_COR_OBJ_TYPE_MO, CL_COR_OBJ_TYPE_MSO }
	This type used to know the type of object the object-handle contains. More...
enum	ClCorObjWalkFlagsT { CL_COR_MOTREE_WALK, CL_COR_MO_WALK, CL_COR_MSO_WALK, CL_COR_MO_SUBTREE_WALK, CL_COR_MSO_SUBTREE_WALK, CL_COR_MO_WALK_UP, CL_COR_MSO_WALK_UP }
	This enumeration type contains the walk related definitions. More...
enum	ClCorOpsT { , CL_COR_OP_CREATE = 0x1, CL_COR_OP_SET = 0x2, CL_COR_OP_DELETE = 0x4, CL_COR_OP_GET = 0x8, CL_COR_OP_CREATE_AND_SET = 0x10, CL_COR_OP_ALL }
	The values of the ClCorOpsT enumeration type contain the Operation IDs. More...
enum	ClCorTxnJobStatus
	To set the status of a job given in the transaction.
enum	ClCorType { , CL_COR_VOID, CL_COR_INT8, CL_COR_UINT8, CL_COR_INT16, CL_COR_UINT16, CL_COR_INT32, CL_COR_UINT32, CL_COR_INT64, CL_COR_UINT64, CL_COR_FLOAT, CL_COR_DOUBLE, CL_COR_COUNTER32, CL_COR_COUNTER64, CL_COR_SEQUENCE32 }
	The ClCorType enumeration contains the basic COR data types. More...

Detailed Description

Header file of all MetaData data structures.

Classes

Macros

Typedefs

Enumerations

Detailed Description