32 #ifndef _CL_CPM_EXT_API_H_
33 #define _CL_CPM_EXT_API_H_
51 typedef struct ClTargetSlotInfo
60 ClCharT customData[256];
63 typedef struct ClTargetInfo
67 ClBoolT installPrerequisites;
68 ClBoolT instantiateImages;
69 ClBoolT createTarballs;
71 ClInt32T gmsMcastPort;
132 typedef struct ClCpmNodeConfig
214 const ClNameT *compName, ClUint32T *pid);
347 extern ClRcT clCpmNodeConfigSet(ClCpmNodeConfigT *nodeConfig);
349 extern ClRcT clCpmNodeConfigGet(
const ClCharT *nodeName, ClCpmNodeConfigT *nodeConfig);
352 ClCharT *name, ClCharT *instantiateCommand,
353 ClAmsCompPropertyT property, ClUint64T mask);
358 CL_IN ClUint64T instantiateCookie,
360 CL_IN ClAmsLocalRecoveryT recommendedRecovery,
361 CL_IN ClUint32T alarmHandle);
364 clCpmTargetSlotInfoGet(
const ClCharT *name,
ClIocNodeAddressT addr, ClTargetSlotInfoT *slotInfo);
367 clCpmTargetInfoGet(ClTargetInfoT *targetInfo);
370 clCpmTargetSlotListGet(ClTargetSlotInfoT *slotInfo, ClUint32T *numSlots);
373 clCpmTargetVersionGet(ClCharT *aspVersion, ClUint32T maxBytes);
376 clCpmIsSCCapable(
void);
Typical defines found in any software project.
Common Error Codes shared across multiple Clovis ASP Components.
Header file for the APIs and data types exposed by the CPM.
Header file of all MetaData data structures.
Header file of Event Manager Related APIs.
ClUint32T ClRcT
Clovis return code type.
Definition: clCommon.h:168
ClInt64T ClTimeT
Time duration specified in nanoseconds.
Definition: clCommon.h:154
#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_MAX_NAME_LENGTH
The Maximum length of most string names in the OpenClovis ASP framework.
Definition: clCommon.h:194
ClUint64T ClSizeT
Definition: clCommon.h:157
#define CL_IN
CL_IN macro assists in clearly defining arguments of an API, but has no actual meaning.
Definition: clCommon.h:106
ClRcT clCpmSlotGet(CL_IN ClCpmSlotInfoFieldIdT flag, CL_OUT ClCpmSlotInfoT *slotInfo)
Returns the Slot related information [ nodeName and IocAddress], provides the mapping between slot ID...
ClRcT clCpmIocAddressForNodeGet(CL_IN ClNameT nodeName, CL_OUT ClIocAddressT *pIocAddress)
Returns the IOC address for the given node.
ClRcT clCpmComponentPIDGet(CL_IN const ClNameT *compName, CL_OUT ClUint32T *pid)
Returns the process ID of the component.
ClBoolT clCpmIsCompRestarted(CL_IN ClNameT compName)
Checks if the given component has been restarted.
ClRcT clCpmSlotInfoGet(CL_IN ClCpmSlotInfoFieldIdT flag, CL_OUT ClCpmSlotInfoT *slotInfo)
Returns the Slot related information [node moID, nodeName and IocAddress], provides the mapping betwe...
ClHandleT ClCpmHandleT
The type of the handle supplied by the CPM to the process which calls the clCpmClientInitialize() API...
Definition: clCpmApi.h:124
ClCpmSlotInfoFieldIdT
The enum which indicates which field of ClCpmSlotInfoT is set and all other information related to it...
Definition: clCpmExtApi.h:81
ClRcT clCpmEventPayLoadExtract(CL_IN ClEventHandleT eventHandle, CL_IN ClSizeT eventDataSize, CL_IN ClCpmEventTypeT cpmEventType, CL_OUT void *payLoad)
Extracts the event payload data.
ClCpmEventTypeT
Types of the events published by the Component Manager.
Definition: clCpmExtApi.h:145
@ CL_CPM_NODE_MOID
Definition: clCpmExtApi.h:97
@ CL_CPM_NODENAME
Flag indicating that name of the node is being passed.
Definition: clCpmExtApi.h:102
@ CL_CPM_IOC_ADDRESS
Flag indicating that IOC address of the node is being passed.
Definition: clCpmExtApi.h:91
@ CL_CPM_SLOT_ID
Flag indicating that slot ID of the node is being passed.
Definition: clCpmExtApi.h:86
@ CL_CPM_COMP_EVENT
Component death event.
Definition: clCpmExtApi.h:149
@ CL_CPM_NODE_EVENT
Node arrival/departure event.
Definition: clCpmExtApi.h:153
ClHandleT ClEventHandleT
The type of a handle to an event.
Definition: clEventApi.h:158
ClUint32T ClIocNodeAddressT
The IOC node address.
Definition: clIocApi.h:343
A name.
Definition: clCommon.h:197
The structure filled by the clCpmSlotInfoGet() API.
Definition: clCpmExtApi.h:110
ClNameT nodeName
Name of the node.
Definition: clCpmExtApi.h:126
ClCorMOIdT nodeMoId
MOID of the node.
Definition: clCpmExtApi.h:122
ClIocNodeAddressT nodeIocAddress
IOC address of the node.
Definition: clCpmExtApi.h:118
ClUint32T slotId
Slot ID of the node.
Definition: clCpmExtApi.h:114
The structure ClCorMOId contains MoId of the object, which is the address of the COR object.
Definition: clCorMetaData.h:918
IOC address.
Definition: clIocApi.h:401