OpenClovis Logo

Classes | Enumerations | Functions
clCpmExtApi.h File Reference

Header file for APIs and data types exposed by CPM for providing extended functionality. More...

#include <clCommon.h>
#include <clCommonErrors.h>
#include <clCpmApi.h>
#include <clEventApi.h>
#include <clCorMetaData.h>

Go to the source code of this file.

Classes

struct  ClCpmSlotInfoT
 The structure filled by the clCpmSlotInfoGet() API. More...

Enumerations

enum  ClCpmEventTypeT {
  CL_CPM_COMP_EVENT,
  CL_CPM_NODE_EVENT
}
 Types of the events published by the Component Manager. More...
enum  ClCpmSlotInfoFieldIdT {
  CL_CPM_SLOT_ID,
  CL_CPM_IOC_ADDRESS,
  CL_CPM_NODE_MOID,
  CL_CPM_NODENAME
}
 The enum which indicates which field of ClCpmSlotInfoT is set and all other information related to it will be filled. More...

Functions

ClRcT clCpmComponentPIDGet (CL_IN ClNameT *compName, CL_OUT ClUint32T *pid)
 Returns the process ID of the component.
ClRcT clCpmEventPayLoadExtract (CL_IN ClEventHandleT eventHandle, CL_IN ClSizeT eventDataSize, CL_IN ClCpmEventTypeT cpmEventType, CL_OUT void *payLoad)
 Extracts the event payload data.
ClRcT clCpmIocAddressForNodeGet (CL_IN ClNameT nodeName, CL_OUT ClIocAddressT *pIocAddress)
 Returns the IOC address for the given node.
ClBoolT clCpmIsCompRestarted (CL_IN ClNameT compName)
 Checks if the given component has been restarted.
ClRcT clCpmSlotGet (CL_IN ClCpmSlotInfoFieldIdT flag, CL_OUT ClCpmSlotInfoT *slotInfo)
 Returns the Slot related information [ nodeName and IocAddress], provides the mapping between slot ID, IOC address,and name of the given node depending on the flag that is passed to it.
ClRcT clCpmSlotInfoGet (CL_IN ClCpmSlotInfoFieldIdT flag, CL_OUT ClCpmSlotInfoT *slotInfo)
 Returns the Slot related information [node moID, nodeName and IocAddress], provides the mapping between slot ID, IOC address, mo ID and name of the given node depending on the flag that is passed to it.

Detailed Description

Header file for APIs and data types exposed by CPM for providing extended functionality.


Generated on Tue Jan 10 10:29:15 PST 2012 for OpenClovis SDK using Doxygen