32 #ifndef _CL_ALARM_API_H_
33 #define _CL_ALARM_API_H_
42 #include <clAlarmOMIpi.h>
453 ClRcT clAlarmReset(
ClCorMOIdPtrT pMoId, VDECL_VER(ClAlarmIdT, 4, 1, 0)* pAlarmId, ClUint32T count);
Typical defines found in any software project.
Header File of Alarm related Definitions.
ClRcT clAlarmLibInitialize()
Initializes the Alarm Library.
ClUint32T ClAlarmHandleT
The type of the handle for identifying the raised alarm.
Definition: clAlarmDefinitions.h:131
ClRcT clAlarmEventDataGet(CL_IN ClUint8T *pData, CL_IN ClSizeT size, CL_OUT ClAlarmHandleInfoT *pAlarmHandleInfo)
This function is used to get the decoded data in host format of the alarm data obtained after receivi...
ClRcT clAlarmStateQuery(CL_IN const ClAlarmInfoT *pAlarmInfo, CL_OUT ClAlarmStateT *const pAlarmState)
\breif Function to get the current state of the alarm.
ClRcT clAlarmPendingAlarmListFree(CL_INOUT ClAlarmPendingAlmListPtrT const pPendingAlmList)
\breif Function to free the pending alarm list populated by clAlarmPendingAlarmsQuery.
ClRcT(* ClAlarmEventCallbackFuncPtrT)(CL_IN const ClAlarmHandleInfoT *pAlarmInfo)
Informs the consumer of the event about the events published by the alarm server.
Definition: clAlarmApi.h:261
ClRcT clAlarmEventUnsubscribe()
This function is used to unsubscribe for the events published by the alarm server.
ClRcT clAlarmPendingAlarmsQuery(CL_IN ClCorMOIdPtrT const pMoId, CL_OUT ClAlarmPendingAlmListPtrT const pPendingAlmList)
\breif Function to get the pending alarms on a specific object or in the whole system.
ClRcT clAlarmVersionVerify(CL_INOUT ClVersionT *pVersion)
This function is used to verify if a version of the function is supported by AM.
ClAlarmStateT
The enumeration to depict the state of the alarm that is into.
Definition: clAlarmDefinitions.h:509
ClRcT clAlarmLibFinalize()
Cleans up the Alarm Library.
ClRcT clAlarmRaise(CL_IN ClAlarmInfoT *pAlarmInfo, CL_OUT ClAlarmHandleT *pAlarmHandle)
Raises an alarm on a component.
ClRcT clAlarmEventSubscribe(CL_IN const ClAlarmEventCallbackFuncPtrT pAlarmEvtCallbackFuncFP)
This function is used to subscribe for the events published by the alarm server.
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
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
Version Information for various services.
Definition: clCommon.h:250
The ClAlarmInfoT data structure is used to store the entire list of alarm attributes that include pro...
Definition: clAlarmDefinitions.h:544
The ClAlarmHandleInfoT data structure is used to store the handle and the information of the alarm.
Definition: clAlarmDefinitions.h:612
Structure to contain the information about the pending alarms.
Definition: clAlarmDefinitions.h:821
The structure ClCorMOId contains MoId of the object, which is the address of the COR object.
Definition: clCorMetaData.h:918