Header file of Clovis Object Registry (COR) related APIs. More...
#include <clCommon.h>
#include <clCorUtilityApi.h>
#include <clCorServiceId.h>
#include <clCorMetaData.h>
Go to the source code of this file.
Functions | |
ClRcT | clCorBundleApply (CL_IN ClCorBundleHandleT bundleHandle) |
Submits a bundle to the COR server for execution. | |
ClRcT | clCorBundleApplyAsync (CL_IN ClCorBundleHandleT bundleHandle, CL_IN ClCorBundleCallbackPtrT funcPtr, CL_IN ClPtrT userArg) |
Function to apply the bundle asynchronously. | |
ClRcT | clCorBundleFinalize (ClCorBundleHandleT bundleHandle) |
Finalizes the bundle. | |
ClRcT | clCorBundleInitialize (CL_OUT ClCorBundleHandlePtrT pBundleHandle, CL_IN ClCorBundleConfigPtrT pBundleConfig) |
Creates a bundle and returns a unique handle identifying the bundle. | |
ClRcT | clCorBundleObjectGet (CL_IN ClCorBundleHandleT bundleHandle, CL_IN const ClCorObjectHandleT *pObjectHandle, CL_INOUT ClCorAttrValueDescriptorListPtrT pAttrList) |
Populates a bundle with read-jobs. | |
ClRcT | clCorLogicalSlotToMoIdGet (ClUint32T logicalSlot, ClCorMOIdPtrT pMoId) |
Returns MOId given the Logical Slot. | |
ClRcT | clCorMoIdToComponentAddressGet (CL_IN ClCorMOIdPtrT moh, CL_OUT ClCorAddrT *addr) |
– IPI's for Route List manipulation – | |
ClRcT | clCorMoIdToLogicalSlotGet (ClCorMOIdPtrT pMoId, ClUint32T *logicalSlot) |
Returns the logical slot. | |
ClRcT | clCorMoIdToNodeNameGet (CL_IN ClCorMOIdPtrT pMoId, CL_OUT ClNameT *nodeName) |
This function can be used to get node name corresponding to a moId which is specified in the ASP configuration file. | |
ClRcT | clCorNodeNameToMoIdGet (CL_IN ClNameT nodeName, CL_OUT ClCorMOIdPtrT pMoId) |
This function can be used to give the MoId corresponding to the node name supplied. | |
ClRcT | clCorObjectAttributeGet (CL_IN ClCorObjectHandleT pHandle, CL_IN ClCorAttrPathPtrT contAttrPath, CL_IN ClCorAttrIdT attrId, CL_IN ClInt32T index, CL_OUT void *value, CL_INOUT ClUint32T *size) |
Retrieves the value of an attribute belonging to an object. | |
ClRcT | clCorObjectAttributeSet (CL_INOUT ClCorTxnSessionIdT *txnSessionId, CL_IN ClCorObjectHandleT pHandle, CL_IN ClCorAttrPathPtrT contAttrPath, CL_IN ClCorAttrIdT attrId, CL_IN ClUint32T index, CL_IN void *value, CL_IN ClUint32T size) |
Sets the attribute of a COR object. | |
ClRcT | clCorObjectAttributeWalk (CL_IN ClCorObjectHandleT objH, CL_IN ClCorObjAttrWalkFilterT *pFilter, CL_IN ClCorObjAttrWalkFuncT fp, CL_IN void *cookie) |
Walk is performed on the attributes of the object. | |
ClRcT | clCorObjectCreate (CL_INOUT ClCorTxnSessionIdT *txnSessionId, CL_IN ClCorMOIdPtrT moId, CL_OUT ClCorObjectHandleT *handle) |
Creates a COR object. | |
ClRcT | clCorObjectCreateAndSet (CL_INOUT ClCorTxnSessionIdT *tid, CL_IN ClCorMOIdPtrT pMoId, CL_IN ClCorAttributeValueListPtrT attrList, CL_OUT ClCorObjectHandleT *pHandle) |
Creates and sets a COR object. | |
ClRcT | clCorObjectDelete (CL_INOUT ClCorTxnSessionIdT *txnSessionId, CL_IN ClCorObjectHandleT handle) |
Deletes a COR object. | |
ClRcT | clCorObjectHandleGet (ClCorMOIdPtrT pMoId, ClCorObjectHandleT *objHandle) |
Retrieves the compressed MO handle corresponding to MOID. | |
ClRcT | clCorObjectHandleToMoIdGet (CL_IN ClCorObjectHandleT objHandle, CL_OUT ClCorMOIdPtrT moId, CL_OUT ClCorServiceIdT *srvcId) |
Returns the MOID corresponding to compressed MO handle. | |
ClRcT | clCorObjectHandleToTypeGet (CL_IN ClCorObjectHandleT pHandle, CL_OUT ClCorObjTypesT *type) |
Returns the type of an object when its object handle is provided. | |
ClRcT | clCorObjectWalk (CL_IN ClCorMOIdPtrT moIdRoot, CL_IN ClCorMOIdPtrT moIdFilter, CL_IN ClCorObjectWalkFunT fp, CL_IN ClCorObjWalkFlagsT flags, CL_IN void *cookie) |
Walks through the object tree. | |
ClRcT | clCorOIRegister (CL_IN const ClCorMOIdPtrT pMoId, CL_IN const ClCorAddrPtrT pCompAaddr) |
A component can register itself as an OI through this API. | |
ClRcT | clCorOIUnregister (CL_IN const ClCorMOIdPtrT pMoId, CL_IN const ClCorAddrPtrT pCompAddr) |
De-register the component acting as the OI. | |
ClRcT | clCorPrimaryOIClear (CL_IN const ClCorMOIdPtrT pMoId, CL_IN const ClCorAddrPtrT pCompAddr) |
De-register the component that is acting as the primary OI. | |
ClRcT | clCorPrimaryOIGet (CL_IN const ClCorMOIdPtrT pMoId, CL_OUT ClCorAddrPtrT pCompAddr) |
Obtains the primary OI for a given MO. | |
ClRcT | clCorPrimaryOISet (CL_IN const ClCorMOIdPtrT pMoId, CL_IN const ClCorAddrPtrT pCompAddr) |
Sets a component as the primary OI. | |
ClRcT | clCorServiceRuleAdd (CL_IN ClCorMOIdPtrT moh, CL_IN ClCorAddrT addr) |
Adds a new route rule entry. | |
ClRcT | clCorServiceRuleDelete (CL_IN ClCorMOIdPtrT moh, CL_IN ClCorAddrT addr) |
Delete the station from the route list. | |
ClRcT | clCorVersionCheck (CL_INOUT ClVersionT *version) |
Verifies the version supported by COR. |
Header file of Clovis Object Registry (COR) related APIs.