113 #ifndef _CL_COR_UTILITY_API_H_
114 #define _CL_COR_UTILITY_API_H_
121 #include <clOmCommonClassTypes.h>
131 #define CL_COR_UTILS_UNKNOWN_ATTRIBUTE 0
133 #define CL_COR_UTILS_UNKNOWN_CLASS 0
175 struct ClCorPersDataTlv
190 typedef struct ClCorPersDataTlv ClCorPersDataTlvT;
203 ClCharT *pOmClassName, ClUint32T maxClassSize);
204 extern ClRcT clCorConfigLoad(
const ClCharT *pConfigFile,
const ClCharT *pRouteFile);
206 extern ClRcT clCorDataRestore();
208 extern ClRcT clCorDataSave();
216 extern ClRcT clCorDataFrequentSaveStop();
233 ClInt32T *pInit, ClInt32T *pMin, ClInt32T *pMax);
1034 extern ClRcT clCorMoIdPack(
ClCorMOIdT *pMoId, ClCharT **ppDataBuffer, ClUint32T *pDataSize);
1035 extern ClRcT clCorMoIdUnpack(ClCharT *pData, ClUint32T dataSize,
ClCorMOIdT *pMoId);
1611 extern ClRcT clCorClientDebugCliRegister(ClHandleT *pDbgHandle);
1613 extern ClRcT clCorClientDebugCliDeregister(ClHandleT dbgHandle);
1615 extern ClRcT clCorClassAttrListGet(ClCharT* className,
1617 ClUint32T* pAttrCount,
1624 extern ClRcT clCorMibTableAttrListGet(ClCharT* mibTable,
1626 ClUint32T* pAttrCount,
Typical defines found in any software project.
Header file of all MetaData data structures.
Header file of COR Service Ids.
ClUint32T ClRcT
Clovis return code type.
Definition: clCommon.h:168
#define CL_INOUT
CL_INOUT macro assists in clearly defining arguments of an API, but has no actual meaning.
Definition: clCommon.h:108
#define CL_OUT
CL_OUT macro assists in clearly defining arguments of an API, but has no actual meaning.
Definition: clCommon.h:110
#define CL_IN
CL_IN macro assists in clearly defining arguments of an API, but has no actual meaning.
Definition: clCommon.h:106
ClRcT clCorMoIdValidate(CL_IN ClCorMOIdPtrT pMoId)
Validates MoId in the input argument.
ClRcT clCorAttrPathClone(ClCorAttrPathPtrT pAttrPath, ClCorAttrPathPtrT *newH)
Clones a particular ClCorAttrPath.
enum ClCorAttrType ClCorAttrTypeT
The values of this enumeration type refer to the COR attribute types.
ClRcT clCorMoIdInitialize(CL_INOUT ClCorMOIdPtrT pMoId)
Initializes a MOID or resets the content of an existing MOID.
void clCorAttrPathShow(CL_IN ClCorAttrPathPtrT pAttrPath)
Displays the COR attribute path in debug mode only.
ClRcT clCorMoIdFree(CL_INOUT ClCorMOIdPtrT pMoId)
Deletes the ClCorMOId handle.
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
ClRcT clCorAttrPathTruncate(CL_INOUT ClCorAttrPathPtrT pAttrPath, CL_IN ClInt16T level)
Removes node after specified level.
ClInt32T ClCorClassTypeT
The type of an identifier for the COR class.
Definition: clCorMetaData.h:201
ClRcT clCorMoIdNextSiblingGet(CL_INOUT ClCorMOIdPtrT pMoId)
Returns the next sibling.
ClRcT clCorMoIdNameToMoIdGet(CL_IN ClNameT *moIdName, CL_OUT ClCorMOIdT *moId)
Retrieves moId in ClCorMOIdT format, when moId is provided in ClNameT format.
ClRcT clCorAttrPathSet(CL_INOUT ClCorAttrPathPtrT pAttrPath, CL_IN ClUint16T level, CL_IN ClCorAttrIdT attrId, CL_IN ClUint32T index)
Sets the attribute ID for a given node.
ClInt32T clCorAttrPathCompare(CL_IN ClCorAttrPathPtrT pAttrPath, CL_IN ClCorAttrPathPtrT cmp)
Compares two ClCorAttrPath.
ClCorMOServiceIdT clCorMoIdServiceGet(CL_IN ClCorMOIdPtrT pMoId)
Returns the service ID.
ClRcT clCorAttrPathIndexSet(CL_INOUT ClCorAttrPathPtrT pAttrPath, CL_IN ClUint16T ndepth, CL_IN ClUint32T newIndex)
Sets the index of COR attribute path.
ClRcT clCorMoIdToMoClassPathGet(CL_IN ClCorMOIdPtrT moIdh, CL_OUT ClCorMOClassPathPtrT corIdh)
Derives the COR path from given a MoId.
ClCorServiceIdT
The members of this enumeration type contains the service ID for all MSPs.
Definition: clCorServiceId.h:57
ClRcT clCorMoIdToMoIdNameGet(CL_IN ClCorMOIdT *moId, CL_OUT ClNameT *moIdName)
Retrieves MoId in ClNameT format, when MoId is provided in ClCorMOIdT format.
ClCorInstanceIdT clCorMoIdToInstanceGet(CL_IN ClCorMOIdPtrT pMoId)
Returns the instance.
ClRcT clCorAttrPathInitialize(CL_INOUT ClCorAttrPathPtrT pAttrPath)
Initializes the attribute path.
ClInt16T clCorMoIdDepthGet(CL_IN ClCorMOIdPtrT pMoId)
Returns node depth of the COR MoId.
ClRcT clCorMoIdToClassGet(CL_IN ClCorMOIdPtrT pMoId, CL_IN ClCorMoIdClassGetFlagsT flag, CL_OUT ClCorClassTypeT *pClassId)
Returns the class type.
ClRcT clCorAttrPathFree(CL_INOUT ClCorAttrPathPtrT pAttrPath)
Deletes the COR attribute path handle.
ClInt32T ClCorAttrIdT
The type of an identifier for a COR attribute.
Definition: clCorMetaData.h:206
ClInt16T clCorAttrPathDepthGet(CL_IN ClCorAttrPathPtrT pAttrPath)
Returns the COR attribute path node depth.
ClRcT clCorAttrPathAlloc(CL_INOUT ClCorAttrPathPtrT *pAttrPath)
Creates an attribute path.
ClRcT clCorMoIdFirstInstanceGet(CL_INOUT ClCorMOIdPtrT pMoId)
Returns the first child.
ClRcT clCorMoIdAlloc(CL_INOUT ClCorMOIdPtrT *pMoId)
Creates an MoId.
ClCorPersDataTypeT
Pre-provisioning related structures.
Definition: clCorUtilityApi.h:139
ClCorClsCfgType
Class specification.
Definition: clCorUtilityApi.h:167
ClRcT clCorMoIdInstanceSet(CL_INOUT ClCorMOIdPtrT pMoId, CL_IN ClUint16T ndepth, CL_IN ClCorInstanceIdT newInstance)
Sets the instance of the MoId.
ClRcT clCorMoIdAppend(CL_INOUT ClCorMOIdPtrT pMoId, CL_IN ClCorClassTypeT type, CL_IN ClCorInstanceIdT instance)
Adds an entry to the MoId.
ClRcT(* ClCorClassAttrWalkFunc)(ClCorClassTypeT clsId, ClCorAttrDefT *attrDef, ClPtrT cookie)
Attribute Walk function prototype.
Definition: clCorMetaData.h:500
ClRcT clCorMoIdSet(CL_INOUT ClCorMOIdPtrT pMoId, CL_IN ClUint16T level, CL_IN ClCorClassTypeT type, CL_IN ClCorInstanceIdT instance)
Sets the class type and instanceId at a given node or level.
ClRcT clCorMoIdServiceSet(CL_INOUT ClCorMOIdPtrT pMoId, CL_IN ClCorMOServiceIdT svc)
Sets the service ID.
ClRcT clCorMoIdConcatenate(CL_INOUT ClCorMOIdPtrT part1, CL_INOUT ClCorMOIdPtrT part2, CL_IN ClInt32T copyWhere)
Concatenates a MoId to another MoId.
ClRcT clCorMoIdTruncate(CL_INOUT ClCorMOIdPtrT pMoId, CL_IN ClInt16T level)
Removes the node after specified level.
ClCorAttrIdT clCorAttrPathToAttrIdGet(CL_IN ClCorAttrPathPtrT pAttrPath)
Returns the attribute ID.
void clCorMoIdShow(CL_IN ClCorMOIdPtrT pMoId)
Displays the ClCorMOId handle.
ClRcT clCorUtilMoAndMSOCreate(CL_IN ClCorMOIdPtrT pMoId, CL_OUT ClCorObjectHandleT *pHandle)
Creates MO and MSO objects.
ClUint32T clCorAttrPathIndexGet(CL_IN ClCorAttrPathPtrT pAttrPath)
Returns the index of COR attribute path.
ClInt16T ClCorMOServiceIdT
This type is part of the ClCorMOIdT type to access a MO or MSO.
Definition: clCorMetaData.h:900
ClInt32T ClCorInstanceIdT
The type of an identifier for a COR instance.
Definition: clCorMetaData.h:211
ClRcT clCorAttrPathAppend(CL_INOUT ClCorAttrPathPtrT pAttrPath, CL_IN ClCorClassTypeT attrId, CL_IN ClCorInstanceIdT index)
Adds an entry to the attribute path.
ClRcT clCorServiceIdValidate(CL_IN ClCorServiceIdT srvcId)
Validates serviceId in the input argument.
enum ClCorClsCfgType ClCorClsCfgTypeT
Class specification.
ClUint32T ClCorAttrFlagT
Typedef for storing the attribute flags.
Definition: clCorMetaData.h:216
ClRcT clCorMoIdClone(ClCorMOIdPtrT pMoId, ClCorMOIdPtrT *newH)
Clones a particular MOId.
int clCorMoIdCompare(CL_IN ClCorMOIdPtrT pMoId, CL_IN ClCorMOIdPtrT cmp)
Compares two MoIds and verifies if they are equal.
ClRcT clCorUtilMoAndMSODelete(CL_IN ClCorMOIdPtrT pMoId)
Deletes MO and MSO objects.
@ CL_COR_PERS_CLASS_DATA
COR classes data.
Definition: clCorUtilityApi.h:144
@ CL_COR_PERS_HIER_DATA
COR class relationship data.
Definition: clCorUtilityApi.h:149
@ CL_COR_PERS_OBJ_DATA
COR objects data.
Definition: clCorUtilityApi.h:154
A name.
Definition: clCommon.h:197
Attribute Definition structure.
Definition: clCorMetaData.h:475
The structure ClCorMOId contains MoId of the object, which is the address of the COR object.
Definition: clCorMetaData.h:918
The structure ClCorAttrPath contains the path-list of the attribute.
Definition: clCorMetaData.h:997
The structure ClCorMOClassPath contains the COR object handle.
Definition: clCorMetaData.h:1212
The timeout value in seconds and milliseconds.
Definition: clTimerApi.h:87