Header file of Alarm Service related APIs. More...
Go to the source code of this file.
Typedefs | |
| typedef ClRcT(* | ClAlarmEventCallbackFuncPtrT )(CL_IN const ClAlarmHandleInfoT *pAlarmInfo) |
| Informs the consumer of the event about the events published by the alarm server. | |
Functions | |
| 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 receiving the event. | |
| ClRcT | clAlarmEventSubscribe (CL_IN const ClAlarmEventCallbackFuncPtrT pAlarmEvtCallbackFuncFP) |
| This function is used to subscribe for the events published by the alarm server. | |
| ClRcT | clAlarmEventUnsubscribe () |
| This function is used to unsubscribe for the events published by the alarm server. | |
| ClRcT | clAlarmLibFinalize () |
| Cleans up the Alarm Library. | |
| ClRcT | clAlarmLibInitialize () |
| Initializes the Alarm Library. | |
| ClRcT | clAlarmPendingAlarmListFree (CL_INOUT ClAlarmPendingAlmListPtrT const pPendingAlmList) |
| Function to free the pending alarm list populated by clAlarmPendingAlarmsQuery. | |
| ClRcT | clAlarmPendingAlarmsQuery (CL_IN ClCorMOIdPtrT const pMoId, CL_OUT ClAlarmPendingAlmListPtrT const pPendingAlmList) |
| Function to get the pending alarms on a specific object or in the whole system. | |
| ClRcT | clAlarmRaise (CL_IN ClAlarmInfoT *pAlarmInfo, CL_OUT ClAlarmHandleT *pAlarmHandle) |
| Raises an alarm on a component. | |
| ClRcT | clAlarmStateQuery (CL_IN const ClAlarmInfoT *pAlarmInfo, CL_OUT ClAlarmStateT *const pAlarmState) |
| Function to get the current state of the alarm. | |
| ClRcT | clAlarmVersionVerify (CL_INOUT ClVersionT *pVersion) |
| This function is used to verify if a version of the function is supported by AM. | |
Header file of Alarm Service related APIs.