clEoApi.h File Reference

Header file of EO related APIs. More...

#include <clCommon.h>
#include <clCommonErrors.h>
#include <clOsalApi.h>
#include <clHeapApi.h>
#include <clQueueApi.h>
#include <clIocApi.h>
#include <clIocManagementApi.h>
#include <clRmdApi.h>
#include <clCntApi.h>
#include <clVersion.h>
#include <clEoConfigApi.h>
#include <clEoErrors.h>
#include <clRadixTree.h>

Go to the source code of this file.

Classes
struct	ClEoClientObjT
	This structure contains the pointer to the callback functions to be registered with the EO and the client specific data. More...
struct	ClEoExecutionObj
	The Execution Object abstracts the properties of a running OS thread or process. More...
struct	ClEoProtoDefT
	This structure contains a list of the protocols registered with the EO. More...
struct	ClEoServiceObj
	This structure is EO Service Object. More...

Macros
#define	CL_EO_CLIENT_BIT_SHIFT   6
	Logs base2 of CL_EO_MAX_NO_FUNC.
#define	CL_EO_EVENT_CHANNEL_NAME   "CL_EO_EVENT_CHANNEL_NAME"
	The Event Channel on which the Water Mark Notification is published.
#define	CL_EO_FN_MASK   (0x3F)
	Hexadecimal of CL_EO_MAX_NO_FUNC -1.
#define	CL_EO_GET_FULL_FN_NUM(cl, fn)
	Defines a mechanism to generate unique RMD function number for the function.
#define	CL_EO_MAX_NO_FUNC   64
	If you change CL_EO_MAX_NO_FUNC, make sure to change CL_EO_CLIENT_BIT_SHIFT CL_EO_FN_MASK.
#define	CL_EO_SERVER_COOKIE_BIT_SIZE   8
	EO server Id enum.
#define	CL_EO_USER_CLIENT_ID_START   CL_EO_CLOVIS_RESERVED_CLIENTID_END
	You can specify a new clientId greater than CL_EO_USER_CLIENT_ID_START.

Typedefs
typedef ClUint32T	ClEoArgT
	EO argument type, this argument will always passed.
typedef ClRcT(*	ClEoCallFuncCallbackT )(CL_IN ClEoPayloadWithReplyCallbackT func, CL_IN ClEoDataT eoArg, CL_IN ClBufferHandleT inMsgHdl, CL_OUT ClBufferHandleT outMsgHdl)
	Function Callback definition for the clEoWalk function.
typedef ClOsalTaskDataT	ClEoDataT
	The type of the EO data.
typedef struct ClEoExecutionObj	ClEoExecutionObjT
	The Execution Object abstracts the properties of a running OS thread or process.
typedef ClRcT(*	ClEoPayloadWithReplyCallbackT )(CL_IN ClEoDataT data, CL_IN ClBufferHandleT inMsgHandle, CL_OUT ClBufferHandleT outMsgHandle)
	RMD with PAYLOAD with REPLY function pointer.
typedef ClRcT(*	ClEoProtoCallbackT )(CL_IN ClEoExecutionObjT *pThis, CL_IN ClBufferHandleT eoRecvMsg, CL_IN ClUint8T priority, CL_IN ClUint8T protoType, CL_IN ClUint32T length, CL_IN ClIocPhysicalAddressT srcAddr)
	Callback to handle incoming messages marked with a particular protocol.
typedef struct ClEoServiceObj	ClEoServiceObjT
	This structure is EO Service Object.

Enumerations
enum	ClEoClientIdT {   CL_EO_NATIVE_COMPONENT_TABLE_ID = 0,   CL_EO_DEFAULT_SERVICE_TABLE_ID,   CL_EO_EO_MGR_CLIENT_TABLE_ID,   CL_EO_COR_CLIENT_TABLE_ID,   CL_EO_EVT_CLIENT_TABLE_ID,   CL_CPM_MGR_CLIENT_TABLE_ID,   CL_ALARM_CLIENT_TABLE_ID ,   CL_GMS_CLIENT_TABLE_ID,   CL_AMS_MGMT_SERVER_TABLE_ID,   CL_AMS_MGMT_CLIENT_TABLE_ID,   CL_LOG_CLIENT_TABLE_ID,   CL_EO_CKPT_CLIENT_TABLE_ID,   CL_EO_RMD_CLIENT_TABLE_ID,   CL_AMS_ENTITY_TRIGGER_TABLE_ID,   CL_CPM_MGMT_CLIENT_TABLE_ID,   CL_MSG_CLIENT_TABLE_ID,   CL_MSG_CLIENT_SERVER_TABLE_ID ,   CL_EO_CLOVIS_RESERVED_CLIENTID_END }
enum	ClEOServiceInstallOrderT {   CL_EO_ADD_TO_FRONT = 0,   CL_EO_ADD_TO_BACK = 1 }

Functions
ClRcT	clEoClientDataGet (CL_IN ClEoExecutionObjT *pThis, CL_IN ClUint32T clientId, CL_OUT ClEoDataT *pData)
	Returns the client specific data.
ClRcT	clEoClientDataSet (CL_IN ClEoExecutionObjT *pThis, CL_IN ClUint32T clientId, CL_IN ClEoDataT data)
	Stores the client specific data.
ClRcT	clEoClientInstall (CL_IN ClEoExecutionObjT *pThis, CL_IN ClUint32T clientId, CL_IN ClEoPayloadWithReplyCallbackT *pFuncs, CL_IN ClEoDataT data, CL_IN ClUint32T nFuncs)
	Installs the function table for a client.
ClRcT	clEoClientUninstall (CL_IN ClEoExecutionObjT *pThis, CL_IN ClUint32T clientId)
	Uninstalls the function table for client.
ClRcT	clEoMyEoIocPortGet (CL_OUT ClIocPortT *pIocPort)
	Returns EO IocPort from task specific area.
ClRcT	clEoMyEoIocPortSet (CL_IN ClIocPortT iocPort)
	Sets the EO thread iocPort.
ClRcT	clEoMyEoObjectGet (CL_OUT ClEoExecutionObjT **pEOObj)
	Returns EO Object from task specific area.
ClRcT	clEoMyEoObjectSet (CL_IN ClEoExecutionObjT *eoObj)
	Stores EO Object in task specific area.
ClRcT	clEoPrivateDataGet (CL_IN ClEoExecutionObjT *pThis, CL_IN ClUint32T type, CL_OUT void **data)
	Returns data from EO specific data area.
ClRcT	clEoPrivateDataSet (CL_IN ClEoExecutionObjT *pThis, CL_IN ClUint32T type, CL_IN void *pData)
	Stores data in EO specific data area.
void	clEoProtoInstall (ClEoProtoDefT *def)
	Install a protocol handler.
void	clEoProtoSwitch (ClEoProtoDefT *def)
	Switch from one handler to another.
void	clEoProtoUninstall (ClUint8T id)
	Remove a protocol handler.
ClRcT	clEoReceiveStart (CL_IN ClEoExecutionObjT *pThis)
	Starts receiving messages for a thread.
ClRcT	clEoServiceInstall (CL_IN ClEoExecutionObjT *pThis, CL_IN ClEoPayloadWithReplyCallbackT pFunction, CL_IN ClUint32T iFuncNum, CL_IN ClEOServiceInstallOrderT order)
	Installs a particular client function.
ClRcT	clEoServiceUninstall (CL_IN ClEoExecutionObjT *pThis, CL_IN ClEoPayloadWithReplyCallbackT pFunction, CL_IN ClUint32T iFuncNum)
	Uninstalls a particular client function.
ClRcT	clEoServiceValidate (CL_IN ClEoExecutionObjT *pThis, CL_IN ClUint32T func)
	Validates the function registration.
ClRcT	clEoWalk (CL_IN ClEoExecutionObjT *pThis, CL_IN ClUint32T func, CL_IN ClEoCallFuncCallbackT pFuncCallout, CL_IN ClBufferHandleT inMsgHdl, CL_OUT ClBufferHandleT outMsgHdl)
	Performs a walk.

Variables
ClCharT	ASP_APP_BINDIR [CL_MAX_NAME_LENGTH]
	Dir where application binaries are located.
ClCharT	ASP_BINDIR [CL_MAX_NAME_LENGTH]
	Dir where ASP binaries are located.
ClCharT	ASP_COMPNAME [CL_MAX_NAME_LENGTH]
	Name of the component.
ClCharT	ASP_CONFIG [CL_MAX_NAME_LENGTH]
	Dir where xml config are located.
ClCharT	ASP_DBDIR [CL_MAX_NAME_LENGTH]
	Dir where persistent db files are to be stored.
ClCharT	ASP_LOGDIR [CL_MAX_NAME_LENGTH]
	Dir where logs are stored.
ClUint32T	ASP_NODEADDR
	Address of the node.
ClCharT	ASP_NODENAME [CL_MAX_NAME_LENGTH]
	Name of the node.
ClCharT	ASP_RUNDIR [CL_MAX_NAME_LENGTH]
	Working dir where programs are run.
ClBoolT	ASP_SC_PROMOTE
	Variable to check if the current node is a SC capable node.
ClCharT	CL_APP_BINDIR [CL_MAX_NAME_LENGTH]
	Dir where application binaries are located.
ClBoolT	SYSTEM_CONTROLLER
	Variable to check if the current node is a system controller node.

Detailed Description

Header file of EO related APIs.