104 #ifndef _CL_COR_API_H_
105 #define _CL_COR_API_H_
131 ClRcT clCorClientInitialize(
void);
133 ClRcT clCorClientFinalize(
void);
188 CL_OUT ClUint32T *userFlags );
1038 ClRcT clCorNIPrimaryOISet (
CL_IN const ClCharT *pResource);
1069 ClRcT clCorNIPrimaryOIClear (
CL_IN const ClCharT *pResource);
1175 CL_IN ClPtrT userArg);
1243 ClRcT clCorBundleAttrValueSet(
1246 CL_IN ClPtrT *pValue);
Typical defines found in any software project.
Header file of all MetaData data structures.
Header file of COR Service Ids.
Header File of COR utility APIs.
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
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.
ClRcT clCorObjectHandleToMoIdGet(CL_IN ClCorObjectHandleT objHandle, CL_OUT ClCorMOIdPtrT moId, CL_OUT ClCorServiceIdT *srvcId)
Returns the MOID corresponding to compressed MO handle.
ClRcT clCorObjectDelete(CL_INOUT ClCorTxnSessionIdT *txnSessionId, CL_IN ClCorObjectHandleT handle)
Deletes a COR object.
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
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
ClInt32T ClCorClassTypeT
The type of an identifier for the COR class.
Definition: clCorMetaData.h:201
ClRcT clCorMoIdToLogicalSlotGet(ClCorMOIdPtrT pMoId, ClUint32T *logicalSlot)
Returns the logical slot.
ClPtrT ClCorTxnIdT
The type of the COR transaction ID used to identify a transaction session.
Definition: clCorMetaData.h:642
ClRcT clCorMoIdToComponentAddressGet(CL_IN ClCorMOIdPtrT moh, CL_OUT ClCorAddrT *addr)
– IPI's for Route List manipulation –
ClRcT clCorObjectHandleGet(ClCorMOIdPtrT pMoId, ClCorObjectHandleT *objHandle)
Retrieves the compressed MO handle corresponding to MOID.
ClCorServiceIdT
The members of this enumeration type contains the service ID for all MSPs.
Definition: clCorServiceId.h:57
ClCorObjFlagsT
MO and MSO related flags Following flags are used to specify:
Definition: clCorMetaData.h:719
ClRcT clCorBundleApplyAsync(CL_IN ClCorBundleHandleT bundleHandle, CL_IN ClCorBundleCallbackPtrT funcPtr, CL_IN ClPtrT userArg)
Function to apply the bundle asynchronously.
ClInt32T ClCorAttrIdT
The type of an identifier for a COR attribute.
Definition: clCorMetaData.h:206
ClRcT clCorObjectCreateAndSet(CL_INOUT ClCorTxnSessionIdT *tid, CL_IN ClCorMOIdPtrT pMoId, CL_IN ClCorAttributeValueListPtrT attrList, CL_OUT ClCorObjectHandleT *pHandle)
Creates and sets a COR object.
ClCorObjTypesT
This type used to know the type of object the object-handle contains.
Definition: clCorMetaData.h:513
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 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 clCorOIUnregister(CL_IN const ClCorMOIdPtrT pMoId, CL_IN const ClCorAddrPtrT pCompAddr)
De-register the component acting as the OI.
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
ClRcT clCorVersionCheck(CL_INOUT ClVersionT *version)
Verifies the version supported by COR.
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.
ClHandleT ClCorBundleHandleT
Type definition of the bundle handle.
Definition: clCorMetaData.h:226
ClRcT clCorObjectCreate(CL_INOUT ClCorTxnSessionIdT *txnSessionId, CL_IN ClCorMOIdPtrT moId, CL_OUT ClCorObjectHandleT *handle)
Creates a COR object.
ClRcT clCorLogicalSlotToMoIdGet(ClUint32T logicalSlot, ClCorMOIdPtrT pMoId)
Returns MOId given the Logical Slot.
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 clCorBundleFinalize(ClCorBundleHandleT bundleHandle)
Finalizes the bundle.
ClRcT clCorBundleApply(CL_IN ClCorBundleHandleT bundleHandle)
Submits a bundle to the COR server for execution.
ClRcT(* ClCorObjectWalkFunT)(void *data, void *cookie)
Type of callback function used for Object Walk.
Definition: clCorMetaData.h:1507
ClRcT clCorOIRegister(CL_IN const ClCorMOIdPtrT pMoId, CL_IN const ClCorAddrPtrT pCompAaddr)
A component can register itself as an OI through this API.
ClRcT clCorServiceRuleAdd(CL_IN ClCorMOIdPtrT moh, CL_IN ClCorAddrT addr)
Adds a new route rule entry.
ClUint32T ClCorTxnJobIdT
The type of COR transaction Job Id, used to identify a job uniquely within a transaction.
Definition: clCorMetaData.h:647
ClRcT clCorPrimaryOISet(CL_IN const ClCorMOIdPtrT pMoId, CL_IN const ClCorAddrPtrT pCompAddr)
Sets a component as the primary OI.
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(* ClCorBundleCallbackPtrT)(ClCorBundleHandleT bundleHandle, ClPtrT userArg)
The callback function for the asynchronous bunlde.
Definition: clCorMetaData.h:1545
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 conf...
ClRcT clCorPrimaryOIGet(CL_IN const ClCorMOIdPtrT pMoId, CL_OUT ClCorAddrPtrT pCompAddr)
Obtains the primary OI for a given MO.
ClRcT clCorServiceRuleDelete(CL_IN ClCorMOIdPtrT moh, CL_IN ClCorAddrT addr)
Delete the station from the route list.
ClRcT clCorObjectHandleToTypeGet(CL_IN ClCorObjectHandleT pHandle, CL_OUT ClCorObjTypesT *type)
Returns the type of an object when its object handle is provided.
ClRcT clCorPrimaryOIClear(CL_IN const ClCorMOIdPtrT pMoId, CL_IN const ClCorAddrPtrT pCompAddr)
De-register the component that is acting as the primary OI.
A name.
Definition: clCommon.h:197
Version Information for various services.
Definition: clCommon.h:250
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 ClCorObjAttrWalkFilter is used to specify filter properties while performing attribute ...
Definition: clCorMetaData.h:1029
The structure ClCorMOClassPath contains the COR object handle.
Definition: clCorMetaData.h:1212
Type to provide the list of attribute values for initialized attributes.
Definition: clCorMetaData.h:1350
Type for the attribute value list.
Definition: clCorMetaData.h:1418
Structure for storing the bundle configuration.
Definition: clCorMetaData.h:1479
The IOC Physical address of an application's communication end point.
Definition: clIocApi.h:383