clAlarmUtils.h File Reference

Header File containing functions and structures used for alarm payload for traps. More...

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

Go to the source code of this file.

Classes
struct	ClAlarmUtilPayLoad
	This structure holds the information about the attributes that need to be provided in the alarm payload. More...
struct	ClAlarmUtilPayLoadList
	The stucture is used to specify the alarm payload information. More...
struct	ClAlarmUtilTlv
	The structure is used to store the information about the variables to be used in the trap. More...
struct	ClAlarmUtilTlvInfo
	This structure holds the information about the attributes that needs to be provided in the alarm payload. More...

Typedefs
typedef struct ClAlarmUtilPayLoadList	ClAlarmUtilPayLoadListT
	The stucture is used to specify the alarm payload information.
typedef struct ClAlarmUtilPayLoad	ClAlarmUtilPayLoadT
	This structure holds the information about the attributes that need to be provided in the alarm payload.
typedef struct ClAlarmUtilTlvInfo	ClAlarmUtilTlvInfoT
	This structure holds the information about the attributes that needs to be provided in the alarm payload.
typedef struct ClAlarmUtilTlv	ClAlarmUtilTlvT
	The structure is used to store the information about the variables to be used in the trap.

Functions
void	clAlarmUtilPayloadBufFree (ClUint8T *pBuf)
	The function to free the buffer obtained after flattening the payload information.
ClRcT	clAlarmUtilPayLoadExtract (ClUint8T *pBuf, ClUint32T size, ClAlarmUtilPayLoadListT **ppPayloadList)
	The function to extract the payload information sent at the time of alarm raise.
ClRcT	clAlarmUtilPayloadFlatten (ClAlarmUtilPayLoadListPtrT pPayLoadList, ClUint32T *pSize, ClUint8T **ppBuf)
	Function to convert the payload information into a flat buffer.
void	clAlarmUtilPayloadListFree (ClAlarmUtilPayLoadListT *pPayloadList)
	Function used to free the payload data-structure allocated during alarm reporting or receive.

Detailed Description

Header File containing functions and structures used for alarm payload for traps.