Defines, Structures, Typedefs, Functions. More...

Files
file	clAlarmApi.h
	Header file of Alarm Service related APIs.
file	clAlarmDefinitions.h
	Header File of Alarm related Definitions.
file	clAlarmErrors.h
	Header file of Alarm Service related Error codes.
file	clAlarmUtils.h
	Header File containing functions and structures used for alarm payload for traps.

Classes
struct	ClAlarmComponentResAlarms
	The structure captures the alarm profile of all alarms that are modeled for each resource in the component. More...
struct	ClAlarmHandleInfoT
	The ClAlarmHandleInfoT data structure is used to store the handle and the information of the alarm. More...
struct	ClAlarmInfoT
	The ClAlarmInfoT data structure is used to store the entire list of alarm attributes that include probable cause, MOID, category, sub-category, severity, and event time along with additional information of the alarm. More...
struct	ClAlarmPendingAlmInfo
	Structure to contain the pending alarm information. More...
struct	ClAlarmPendingAlmList
	Structure to contain the information about the pending alarms. More...
struct	ClAlarmProfile
	This structure is used to store the alarm related attributes including the category, sub-category, severity, soaking time for assert and clear, probable cause of alarm, and the generation and suppression rule for alarm. More...
struct	ClAlarmRuleEntryT
	This structure contains the information about the alarm configured. More...
struct	ClAlarmRuleInfoT
	This structure specifies the alarm rule relation and the alarms IDs (probable cause) that participate in the alarm rule. More...
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...

Macros
#define	CL_ALARM_ERR_EVT_CHANNEL_CLOSE 0x10c
	The event channel close failure while unsubscribing for the event.
#define	CL_ALARM_ERR_EVT_CHANNEL_OPEN 0x109
	The event channel open failure for alarm event channel.
#define	CL_ALARM_ERR_EVT_FINALIZE 0x10d
	The event finalize failure while unsubscribing for the event.
#define	CL_ALARM_ERR_EVT_INIT 0x108
	The event initialization failure.
#define	CL_ALARM_ERR_EVT_SUBSCRIBE 0x10a
	Failed while subscribing for the event.
#define	CL_ALARM_ERR_EVT_SUBSCRIBE_AGAIN 0x10b
	The event initialization had been done already.
#define	CL_ALARM_ERR_GEN_RULE_NOT_VALID 0x104
	The Generation Rule of alarm is invalid.
#define	CL_ALARM_ERR_INTERNAL_ERROR 0x107
	Internal error related to alarms.
#define	CL_ALARM_ERR_INVALID_CAT 0x100
	Alarm service related error codes.
#define	CL_ALARM_ERR_INVALID_MOID 0x10e
	The managed object Identifier is invalid.
#define	CL_ALARM_ERR_INVALID_PARAM CL_ERR_INVALID_PARAMETER
	The parameter passed in invalid.
#define	CL_ALARM_ERR_INVALID_SEVERITY 0x102
	The alarm severity is invalid.
#define	CL_ALARM_ERR_NO_MEMORY CL_ERR_NO_MEMORY
	There is no memory left with the application.
#define	CL_ALARM_ERR_NO_OWNER 0x10f
	The managed object doesn't have any owner registered in COR.
#define	CL_ALARM_ERR_NULL_POINTER CL_ERR_NULL_POINTER
	The pointer passed is NULL.
#define	CL_ALARM_ERR_OM_CREATE_FAILED 0x106
	The OM class creation of alarm failed.
#define	CL_ALARM_ERR_PROB_CAUSE_NOT_PRESENT 0x103
	The probable cause of alarm is not present.
#define	CL_ALARM_ERR_SUPP_RULE_NOT_VALID 0x105
	The Suppression Rule of alarm is invalid.
#define	CL_ALARM_ERR_VERSION_UNSUPPORTED 0x101
	Client Library version error.
#define	CL_ALARM_EVENT 1
	Event Type to be specifed while subscribing for the events published by alarm server.
#define	CL_ALARM_RC(ERROR_CODE) CL_RC(CL_CID_ALARMS, (ERROR_CODE))
	It appends the component ID with the error code.
#define	ClAlarmEventName "CL_ALARM_EVENT_CHANNEL"
	ID to specify whether the alarm is invalid or not.

Typedefs
typedef struct ClAlarmComponentResAlarms	ClAlarmComponentResAlarmsT
	The structure captures the alarm profile of all alarms that are modeled for each resource in the component.
typedef ClRcT(*	ClAlarmEventCallbackFuncPtrT )(CL_IN const ClAlarmHandleInfoT *pAlarmInfo)
	Informs the consumer of the event about the events published by the alarm server.
typedef ClUint32T	ClAlarmHandleT
	The type of the handle for identifying the raised alarm.
typedef ClAlarmInfoT *	ClAlarmInfoPtrT
	Pointer type for ClAlarmInfoT.
typedef ClAlarmPendingAlmInfoT *	ClAlarmPendingAlmInfoPtrT
	Pointer type for ClAlarmPendingAlmInfoT.
typedef struct ClAlarmPendingAlmInfo	ClAlarmPendingAlmInfoT
	Structure to contain the pending alarm information.
typedef ClAlarmPendingAlmListT *	ClAlarmPendingAlmListPtrT
	Pointer type for ClAlarmPendingAlmListT.
typedef struct ClAlarmPendingAlmList	ClAlarmPendingAlmListT
	Structure to contain the information about the pending alarms.
typedef struct ClAlarmProfile	ClAlarmProfileT
	This structure is used to store the alarm related attributes including the category, sub-category, severity, soaking time for assert and clear, probable cause of alarm, and the generation and suppression rule for alarm.
typedef ClUint32T	ClAlarmSpecificProblemT
	The type of an identifier to the specific problem of the alarm.
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.

Enumerations
enum	ClAlarmCategoryTypeT { CL_ALARM_CATEGORY_INVALID = 0, CL_ALARM_CATEGORY_COMMUNICATIONS = 1, CL_ALARM_CATEGORY_QUALITY_OF_SERVICE = 2, CL_ALARM_CATEGORY_PROCESSING_ERROR = 3, CL_ALARM_CATEGORY_EQUIPMENT = 4, CL_ALARM_CATEGORY_ENVIRONMENTAL = 5 }
	Enumeration defining the categories of alarms support by alarm server. More...
enum	ClAlarmFetchModeT { CL_ALARM_REPORT = 0, CL_ALARM_POLL }
	Enums for alarm fetch mode. More...
enum	ClAlarmProbableCauseT { CL_ALARM_ID_INVALID = 0, CL_ALARM_PROB_CAUSE_LOSS_OF_SIGNAL = 1, CL_ALARM_PROB_CAUSE_LOSS_OF_FRAME, CL_ALARM_PROB_CAUSE_FRAMING_ERROR, CL_ALARM_PROB_CAUSE_LOCAL_NODE_TRANSMISSION_ERROR, CL_ALARM_PROB_CAUSE_REMOTE_NODE_TRANSMISSION_ERROR, CL_ALARM_PROB_CAUSE_CALL_ESTABLISHMENT_ERROR, CL_ALARM_PROB_CAUSE_DEGRADED_SIGNAL, CL_ALARM_PROB_CAUSE_COMMUNICATIONS_SUBSYSTEM_FAILURE, CL_ALARM_PROB_CAUSE_COMMUNICATIONS_PROTOCOL_ERROR, CL_ALARM_PROB_CAUSE_LAN_ERROR, CL_ALARM_PROB_CAUSE_DTE, CL_ALARM_PROB_CAUSE_RESPONSE_TIME_EXCESSIVE, CL_ALARM_PROB_CAUSE_QUEUE_SIZE_EXCEEDED, CL_ALARM_PROB_CAUSE_BANDWIDTH_REDUCED, CL_ALARM_PROB_CAUSE_RETRANSMISSION_RATE_EXCESSIVE, CL_ALARM_PROB_CAUSE_THRESHOLD_CROSSED, CL_ALARM_PROB_CAUSE_PERFORMANCE_DEGRADED, CL_ALARM_PROB_CAUSE_CONGESTION, CL_ALARM_PROB_CAUSE_RESOURCE_AT_OR_NEARING_CAPACITY, CL_ALARM_PROB_CAUSE_STORAGE_CAPACITY_PROBLEM, CL_ALARM_PROB_CAUSE_VERSION_MISMATCH, CL_ALARM_PROB_CAUSE_CORRUPT_DATA, CL_ALARM_PROB_CAUSE_CPU_CYCLES_LIMIT_EXCEEDED, CL_ALARM_PROB_CAUSE_SOFWARE_ERROR, CL_ALARM_PROB_CAUSE_SOFTWARE_PROGRAM_ERROR, CL_ALARM_PROB_CAUSE_SOFWARE_PROGRAM_ABNORMALLY_TERMINATED, CL_ALARM_PROB_CAUSE_FILE_ERROR, CL_ALARM_PROB_CAUSE_OUT_OF_MEMORY, CL_ALARM_PROB_CAUSE_UNDERLYING_RESOURCE_UNAVAILABLE, CL_ALARM_PROB_CAUSE_APPLICATION_SUBSYSTEM_FAILURE, CL_ALARM_PROB_CAUSE_CONFIGURATION_OR_CUSTOMIZATION_ERROR, CL_ALARM_PROB_CAUSE_POWER_PROBLEM, CL_ALARM_PROB_CAUSE_TIMING_PROBLEM, CL_ALARM_PROB_CAUSE_PROCESSOR_PROBLEM, CL_ALARM_PROB_CAUSE_DATASET_OR_MODEM_ERROR, CL_ALARM_PROB_CAUSE_MULTIPLEXER_PROBLEM, CL_ALARM_PROB_CAUSE_RECEIVER_FAILURE, CL_ALARM_PROB_CAUSE_TRANSMITTER_FAILURE, CL_ALARM_PROB_CAUSE_RECEIVE_FAILURE, CL_ALARM_PROB_CAUSE_TRANSMIT_FAILURE, CL_ALARM_PROB_CAUSE_OUTPUT_DEVICE_ERROR, CL_ALARM_PROB_CAUSE_INPUT_DEVICE_ERROR, CL_ALARM_PROB_CAUSE_INPUT_OUTPUT_DEVICE_ERROR, CL_ALARM_PROB_CAUSE_EQUIPMENT_MALFUNCTION, CL_ALARM_PROB_CAUSE_ADAPTER_ERROR, CL_ALARM_PROB_CAUSE_TEMPERATURE_UNACCEPTABLE, CL_ALARM_PROB_CAUSE_HUMIDITY_UNACCEPTABLE, CL_ALARM_PROB_CAUSE_HEATING_OR_VENTILATION_OR_COOLING_SYSTEM_PROBLEM, CL_ALARM_PROB_CAUSE_FIRE_DETECTED, CL_ALARM_PROB_CAUSE_FLOOD_DETECTED, CL_ALARM_PROB_CAUSE_TOXIC_LEAK_DETECTED, CL_ALARM_PROB_CAUSE_LEAK_DETECTED, CL_ALARM_PROB_CAUSE_PRESSURE_UNACCEPTABLE, CL_ALARM_PROB_CAUSE_EXCESSIVE_VIBRATION, CL_ALARM_PROB_CAUSE_MATERIAL_SUPPLY_EXHAUSTED, CL_ALARM_PROB_CAUSE_PUMP_FAILURE, CL_ALARM_PROB_CAUSE_ENCLOSURE_DOOR_OPEN }
	This enumeration defines all the probable causes of the alarm based on the categories. More...
enum	ClAlarmRuleRelationT { CL_ALARM_RULE_NO_RELATION = 0, CL_ALARM_RULE_LOGICAL_OR, CL_ALARM_RULE_LOGICAL_AND, CL_ALARM_RULE_RELATION_INVALID }
	The enum enumerates the possible relationships between two alarms. More...
enum	ClAlarmSeverityTypeT { CL_ALARM_SEVERITY_INVALID = 0, CL_ALARM_SEVERITY_CRITICAL = 1, CL_ALARM_SEVERITY_MAJOR = 2, CL_ALARM_SEVERITY_MINOR = 3, CL_ALARM_SEVERITY_WARNING = 4, CL_ALARM_SEVERITY_INDETERMINATE = 5, CL_ALARM_SEVERITY_CLEAR = 6 }
	Enumeration to depict the severity of the alarm which is specified while modeling and also while publishing the alarm. More...
enum	ClAlarmStateT { CL_ALARM_STATE_INVALID = -1, CL_ALARM_STATE_CLEAR = 0, CL_ALARM_STATE_ASSERT = 1, CL_ALARM_STATE_SUPPRESSED = 2, CL_ALARM_STATE_UNDER_SOAKING = 3 }
	The enumeration to depict the state of the alarm that is into. More...

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.
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.
ClRcT	clAlarmVersionVerify (CL_INOUT ClVersionT *pVersion)
	This function is used to verify if a version of the function is supported by AM.

Detailed Description

Defines, Structures, Typedefs, Functions.

Macro Definition Documentation

#define CL_ALARM_ERR_INVALID_CAT 0x100

Alarm service related error codes.

The alarm category is invalid.

#define ClAlarmEventName "CL_ALARM_EVENT_CHANNEL"

ID to specify whether the alarm is invalid or not.

Alarm event channel name. This is the channel on which the subscriber will be waiting for notifications.

Typedef Documentation

typedef ClRcT(* ClAlarmEventCallbackFuncPtrT)(CL_IN const ClAlarmHandleInfoT *pAlarmInfo)

Informs the consumer of the event about the events published by the alarm server.

Header File:: clAlarmApi.h

Parameters

pAlarmInfo (in) pointer to the ClAlarmInfoT structure. This structure will populated by the alarm client upon receiving the event on CL_ALARM_EVENT_CHANNEL and then the callback function will called.

Return values

CL_OK The callback function successfully executed.

Description:: This function is registered by using the function clAlarmEventSubscribe in order to receive the events published by the alarm server. The alarm client listens for all the events published on event channel CL_ALARM_EVENT_CHANNEL by the alarm server. When the event is published, the alarm client would call this registered function.

Library File:: ClAlarmClient

See Also: clAlarmEventSubscribe

typedef ClUint32T ClAlarmSpecificProblemT

The type of an identifier to the specific problem of the alarm.

This information is not configured but is assigned a value at run-time for segregation of alarms that have the same category and probable cause but are different in their manifestation.

typedef struct ClAlarmUtilPayLoadList ClAlarmUtilPayLoadListT

The stucture is used to specify the alarm payload information.

The number of resources for which the payload information should be given is specified as the value of numPayLoadEnteries. The different entries corresponding to different resources should be specified in the pPayload array after allocating it. For each resource there can be multiple attributes whose information should be specified in the array of pTlv element of the ClAlarmUtilTlvPtrT.

typedef struct ClAlarmUtilPayLoad ClAlarmUtilPayLoadT

This structure holds the information about the attributes that need to be provided in the alarm payload.

This payload is then used by the SNMP subagent for reporting the trap. This is a structure which contains the information about the traps. This structure is similar to the ClAlarmUtilTlvInfoT but this has the MOId of the resource as an extra field. The SNMP subagent extracts the payload information using this structure So a user planning to report an alarm as trap he/she should provide the attribute information in this structure only.

typedef struct ClAlarmUtilTlvInfo ClAlarmUtilTlvInfoT

This structure holds the information about the attributes that needs to be provided in the alarm payload.

This payload is then used by the SNMP subagent for reporting the trap after receiving the event published by alarm server. The structure is used to store the number of attributes and pointer to the array of structure containing information about attributes that needs to be part of the trap information. The pointer to the array of the structure ClAlarmUtilTlvT has to be allocated which has the number of elements equal to the value of numTlvs element.

typedef struct ClAlarmUtilTlv ClAlarmUtilTlvT

The structure is used to store the information about the variables to be used in the trap.

This takes the type of the attribute which is one of the value from the enum ClCorTypeT, the length of the atttribute and the value of the variable. The element value is a pointer which should be allocated of size equal to value of the element length.

Enumeration Type Documentation

enum ClAlarmCategoryTypeT

Enumeration defining the categories of alarms support by alarm server.

Enumerator:

CL_ALARM_CATEGORY_INVALID	Category for alarms that are not valid.
CL_ALARM_CATEGORY_COMMUNICATIONS	Category for alarms that are related to communication between to points.
CL_ALARM_CATEGORY_QUALITY_OF_SERVICE	Category for alarms that are related to degrations in quality of service.
CL_ALARM_CATEGORY_PROCESSING_ERROR	Category for alarms that are related to software or processing error.
CL_ALARM_CATEGORY_EQUIPMENT	Category for alarms that are related to equipment problems.
CL_ALARM_CATEGORY_ENVIRONMENTAL	Category for alarms that are related to environmental conditions around the equipment.

enum ClAlarmFetchModeT

Enums for alarm fetch mode.

Enumerator:

CL_ALARM_REPORT

There are two ways to get alarm notification for the alarm client:

The alarm can be reported by the application or any other component that is monitoring.

CL_ALARM_POLL

The alarm client polls a resource on which the alarm may be raised.

enum ClAlarmProbableCauseT

This enumeration defines all the probable causes of the alarm based on the categories.

Enumerator:

CL_ALARM_ID_INVALID	invalid cause
CL_ALARM_PROB_CAUSE_LOSS_OF_SIGNAL	Probable cause for alarms which can occur due to communication related problems between two points. An error condition when there is no data in the communication channel.
CL_ALARM_PROB_CAUSE_LOSS_OF_FRAME	An inability to locate the information in bit-delimiters.
CL_ALARM_PROB_CAUSE_FRAMING_ERROR	Error in the bit-groups delimiters within the bit-stream.
CL_ALARM_PROB_CAUSE_LOCAL_NODE_TRANSMISSION_ERROR	An error has occured in the transmission between local node and adjacent node.
CL_ALARM_PROB_CAUSE_REMOTE_NODE_TRANSMISSION_ERROR	An error has occurred on the transmission channel beyond the adjacent node.
CL_ALARM_PROB_CAUSE_CALL_ESTABLISHMENT_ERROR	Error occured while establishing the connection.
CL_ALARM_PROB_CAUSE_DEGRADED_SIGNAL	The quality of the singal has decreased.
CL_ALARM_PROB_CAUSE_COMMUNICATIONS_SUBSYSTEM_FAILURE	A failure in the subsystem which supports communication over telecommunication links.
CL_ALARM_PROB_CAUSE_COMMUNICATIONS_PROTOCOL_ERROR	The communication protocol has been voilated.
CL_ALARM_PROB_CAUSE_LAN_ERROR	Problem detected in the local area network.
CL_ALARM_PROB_CAUSE_DTE	Probable cause of the alarm is data transmission error.
CL_ALARM_PROB_CAUSE_RESPONSE_TIME_EXCESSIVE	Probable causes of alarms caused due to degradation in quality of service. The time delays between the query and its result is beyond the allowable limits.
CL_ALARM_PROB_CAUSE_QUEUE_SIZE_EXCEEDED	The number of items to be processed has exceeded the specified limits.
CL_ALARM_PROB_CAUSE_BANDWIDTH_REDUCED	The bandwidth available for transmission has reduced.
CL_ALARM_PROB_CAUSE_RETRANSMISSION_RATE_EXCESSIVE	Number of repeat transmission is beyond the allowed limits.
CL_ALARM_PROB_CAUSE_THRESHOLD_CROSSED	The limit allowed (or configured) has exceeded.
CL_ALARM_PROB_CAUSE_PERFORMANCE_DEGRADED	Service limit or service aggrement are outside the acceptable limits.
CL_ALARM_PROB_CAUSE_CONGESTION	System is reaching its capacity or approaching it.
CL_ALARM_PROB_CAUSE_RESOURCE_AT_OR_NEARING_CAPACITY	Probable cause of the alarm is the maximum capacity is already reached or about to be reached.
CL_ALARM_PROB_CAUSE_STORAGE_CAPACITY_PROBLEM	Probable causes of alarm caused due to software or processing errors. Probable cause of the alarm is storage capacity problem.
CL_ALARM_PROB_CAUSE_VERSION_MISMATCH	There is a mismatch in the version of two communicating entities.
CL_ALARM_PROB_CAUSE_CORRUPT_DATA	An error has caused the data to be incorrect.
CL_ALARM_PROB_CAUSE_CPU_CYCLES_LIMIT_EXCEEDED	CPU cycles limited has been exceeded its limit.
CL_ALARM_PROB_CAUSE_SOFWARE_ERROR	Probable cause of alarm is error in software.
CL_ALARM_PROB_CAUSE_SOFTWARE_PROGRAM_ERROR	Probable cause of alarm is error in software program error.
CL_ALARM_PROB_CAUSE_SOFWARE_PROGRAM_ABNORMALLY_TERMINATED	Probable cause of alarm is software program abnormally terminated.
CL_ALARM_PROB_CAUSE_FILE_ERROR	Format of the file is incorrect.
CL_ALARM_PROB_CAUSE_OUT_OF_MEMORY	There is no program-addressable storage available.
CL_ALARM_PROB_CAUSE_UNDERLYING_RESOURCE_UNAVAILABLE	An entity upon which the reporting object depends has become unreliable.
CL_ALARM_PROB_CAUSE_APPLICATION_SUBSYSTEM_FAILURE	A failure is detected in the application subsystem failure. A subsystem can be a software supporting the larger module.
CL_ALARM_PROB_CAUSE_CONFIGURATION_OR_CUSTOMIZATION_ERROR	The parameter for configuration or customization are given improperly.
CL_ALARM_PROB_CAUSE_POWER_PROBLEM	Probable cause alarms caused due to equipment related problems. There is a problem with the power supply.
CL_ALARM_PROB_CAUSE_TIMING_PROBLEM	The process which has timing constraints didn't complete with the specified time or has completed but the results are not reliable.
CL_ALARM_PROB_CAUSE_PROCESSOR_PROBLEM	Internal machine error has occurred on the a Central processing Unit.
CL_ALARM_PROB_CAUSE_DATASET_OR_MODEM_ERROR	An internal error has occured on a dataset or modem.
CL_ALARM_PROB_CAUSE_MULTIPLEXER_PROBLEM	Error occured while multiplexing the communication signal.
CL_ALARM_PROB_CAUSE_RECEIVER_FAILURE	Probable cause of alarm is receiver failure.
CL_ALARM_PROB_CAUSE_TRANSMITTER_FAILURE	Probable cause of alarm is transamitter failure.
CL_ALARM_PROB_CAUSE_RECEIVE_FAILURE	Probable cause of alarm is receive failure.
CL_ALARM_PROB_CAUSE_TRANSMIT_FAILURE	Probable cause of alarm is transmission failure.
CL_ALARM_PROB_CAUSE_OUTPUT_DEVICE_ERROR	Error has occured on a output device.
CL_ALARM_PROB_CAUSE_INPUT_DEVICE_ERROR	Probable cause of alarm is input device error.
CL_ALARM_PROB_CAUSE_INPUT_OUTPUT_DEVICE_ERROR	Probable cause of alarm is input output device error.
CL_ALARM_PROB_CAUSE_EQUIPMENT_MALFUNCTION	Internal error in equipment malfunction for which no actual cause has been identified.
CL_ALARM_PROB_CAUSE_ADAPTER_ERROR	Probable cause of alarm is adapter error.
CL_ALARM_PROB_CAUSE_TEMPERATURE_UNACCEPTABLE	Probable cause of alarms caused due to environmental changes around the equipment. Probable cause of alarm is temperature unacceptable.
CL_ALARM_PROB_CAUSE_HUMIDITY_UNACCEPTABLE	Probable cause of alarm is humidity unacceptable around equipment.
CL_ALARM_PROB_CAUSE_HEATING_OR_VENTILATION_OR_COOLING_SYSTEM_PROBLEM	Probable cause of alarm is heating or ventillation or cooling system problem.
CL_ALARM_PROB_CAUSE_FIRE_DETECTED	Probable cause of alarm is fire around the equipment.
CL_ALARM_PROB_CAUSE_FLOOD_DETECTED	Probable cause of alarm is flood around equipment.
CL_ALARM_PROB_CAUSE_TOXIC_LEAK_DETECTED	Probable cause of alarm is toxic leak is detected around equipment.
CL_ALARM_PROB_CAUSE_LEAK_DETECTED	A leak of gas or fluid is detected around equipment.
CL_ALARM_PROB_CAUSE_PRESSURE_UNACCEPTABLE	The fluid or gas pressure is unacceptable.
CL_ALARM_PROB_CAUSE_EXCESSIVE_VIBRATION	The vibration around the equipment has exceeded the limit.
CL_ALARM_PROB_CAUSE_MATERIAL_SUPPLY_EXHAUSTED	Probable cause of alarm is exhaustion of the materail supply.
CL_ALARM_PROB_CAUSE_PUMP_FAILURE	Error has occured in the pump which is used to trasfer fluid in the equipment.
CL_ALARM_PROB_CAUSE_ENCLOSURE_DOOR_OPEN	Probable cause of alarm is enclosure door is open.

enum ClAlarmRuleRelationT

The enum enumerates the possible relationships between two alarms.

Enumerator:

CL_ALARM_RULE_NO_RELATION	If there is only one alarm, then there is no relationship that must be determined. If there is more than one alarm, then the relationship between them must be determined. The relationship can be either a logical OR or a logical AND.
CL_ALARM_RULE_LOGICAL_OR	The alarm is raised or cleared, if at least one of the alarms (specified in the modeling) exist.
CL_ALARM_RULE_LOGICAL_AND	The alarm is raised or cleared, only if all the alarms (specified in the modeling) exist.
CL_ALARM_RULE_RELATION_INVALID	There is no valid relation between the alarms (specified in the modeling).

enum ClAlarmSeverityTypeT

Enumeration to depict the severity of the alarm which is specified while modeling and also while publishing the alarm.

Enumerator:

CL_ALARM_SEVERITY_INVALID	Alarm with invalid severity.
CL_ALARM_SEVERITY_CRITICAL	Alarm with severity level as critical.
CL_ALARM_SEVERITY_MAJOR	Alarm with severity level as major.
CL_ALARM_SEVERITY_MINOR	Alarm with severity level as minor.
CL_ALARM_SEVERITY_WARNING	Alarm with severity level warning.
CL_ALARM_SEVERITY_INDETERMINATE	Alarm with severity level indeterminate.
CL_ALARM_SEVERITY_CLEAR	Alarm with severity level as cleared.

enum ClAlarmStateT

The enumeration to depict the state of the alarm that is into.

It can be in any of the following state that is cleared, assert, suppressed or under soaking.

Enumerator:

CL_ALARM_STATE_INVALID	Invalid alarm state.
CL_ALARM_STATE_CLEAR	The alarm condition has cleared.
CL_ALARM_STATE_ASSERT	The alarm condition has occured.
CL_ALARM_STATE_SUPPRESSED	The alarm state is suppressed.
CL_ALARM_STATE_UNDER_SOAKING	The alarm state is under soaking.

Function Documentation

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.

Header File:: clAlarmApi.h

Parameters

pData	(in)The data received through the event on the alarm event channel.
size	(in)The size of pData.
pAlarmHandleInfo	(out)This parameter is filled with the decoded data into alarm info.

Return values

CL_OK	The function executed successfully.
CL_ALARM_ERR_NULL_POINTER	On passing null pointer in pData or pAlarmHandleInfo.

Description:: The Alarm Server encodes the alarm information into network byte format before publishing the event. This function is used to get the decoded alarm information into host byte format in the events delivery callback function. Before using this function user needs to get the data and its size from the event client using the clEventDataGet() API and pass that information to this function. This function converts the encoded data into host format and fills that into pAlarmHandleInfo parameter.

Library File:: ClAlarmClient

ClRcT clAlarmEventSubscribe ( CL_IN const ClAlarmEventCallbackFuncPtrT pAlarmEvtCallbackFuncFP )

This function is used to subscribe for the events published by the alarm server.

Header File:: clAlarmApi.h

Parameters

pAlarmEvtCallbackFuncFP (in) Pointer to the function which would be called once the event is published by the alarm server.

Return values

CL_OK	The function executed successfully.
CL_ALARM_ERR_NULL_POINTER	The pointer to the function passed is NULL.
CL_ALARM_ERR_EVT_INIT	Failed while initializing the event handle.
CL_ALARM_ERR_EVT_CHANNEL	Failed while opening the alarm event channel.
CL_ALARM_ERR_EVT_SUBSCRIBE	Failed while setting the alarm event patten in subscribe.
CL_ALARM_ERR_EVT_SUBSCRIBE_AGAIN	Failed while doing duplicate subscription.

Description:: This function is used to subscribe for the events published by the alarm server. This function takes the function pointer as parameter which would be called whenever the event is published by the alarm server on the event channel CL_ALARM_EVENT_CHANNEL. After receiving the event the callback function would be called after filling the alarm information in the ClAlarmHandleInfoT structure. The event subscription done via this function can be unsubscribed using the clAlarmEventUnsubscribe().

Library File:: ClAlarmClient

See Also: clAlarmEventUnsubscribe()

ClRcT clAlarmEventUnsubscribe ( )

This function is used to unsubscribe for the events published by the alarm server.

Header File:: clAlarmApi.h

Parameters: None.

Return values

CL_OK	The function executed successfully.
CL_ALARM_ERR_EVT_CHANNEL_CLOSE	The function failed while closing the event channel.
CL_ALARM_ERR_EVT_FINALIZE	The function failed while doing event finalize.

Description:: This function is used to unsubscribe for the event published by the alarm server on the channel CL_ALARM_EVENT_CHANNEL. After this function is called, the callback registered by the function clAlarmEventSubscribe will not be called any further on the event publish. This function will finalize the event handle and will close the event channel opened by calling clAlarmEventSubscribe().

Library File:: ClAlarmClient

See Also: clAlarmEventSubscribe()

ClRcT clAlarmLibFinalize ( )

Cleans up the Alarm Library.

Header File:: clAlarmApi.h

Parameters:: None.

Return values

CL_OK	The function executed successfully.
CL_ALARM_CLIENT_ERR_FINALIZE_FAILED	If alarm service finalization failed.

Description:: This function is used to clean-up alarm library linked to the component and frees resources allocated to it at the time of initialization. It is called when the alarm-related services are no longer required.

Library File:: ClAlarmClient

See Also: clAlarmLibInitialize()

ClRcT clAlarmLibInitialize ( )

Initializes the Alarm Library.

Header File:: clAlarmApi.h

Parameters:: None

Return values

CL_OK	The function executed successfully.
CL_ALARM_CLIENT_ERR_INIT_FAILED	If alarm service initialization failed.

Description:: This function is used to initialize the alarm client library and start up the alarm related services for a given component. It initializes the various callbacks and allocates resources. This function must be invoked before invoking any other alarm-related function.

Library File:: ClAlarmClient

See Also: clAlarmLibFinalize()

ClRcT clAlarmPendingAlarmListFree ( CL_INOUT ClAlarmPendingAlmListPtrT const pPendingAlmList )

Function to free the pending alarm list populated by clAlarmPendingAlarmsQuery.

Header File:: clAlarmApi.h

Parameters: pPendingAlmList (in out) : The pointer to the structure containing the list of pending alarms.

Return values

CL_OK	: The function exection was successful.
CL_ERR_NULL_POINTER	: The pointer is passed to the function.

Description: The function should be used to free the pending alarm list returned by the clAlarmPendingAlarmsQuery () function.

Library File:: ClAlarmClient

See Also: 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.

Header File:: clAlarmApi.h

Parameters

Parameters

pMoId	(in) : It is the pointer to the resource MOID for which the query for all the alarms needs to be done. If NULL is passed, then the function will return all the pending alarms in the system.
pPendingAlmList	(out) : It is a pointer to the structure of type ClAlarmPendingAlmListT. After the api returns successfully, this parameter will contain the count and the array of pending alarms information which is of type ClAlarmInfoT.

Return values

CL_OK	: The function got executed successfully.
CL_ALARM_ERR_NO_OWNER	: There is no registered owner for the alarm resource.
CL_ERR_NULL_POINTER	: NULL pointer passed for either pMoId or pPendingAlmList.
CL_ERR_NO_MEMORY	: No memory avaible.

Description: The function is used to get list of all the pending alarms. The function is either called with a specific resource MOID for getting all the pending alarms on that managed object, or it can be used for getting all the pending alarms present in the system. For getting all the pending alarms in the system, the first parameter should be given as NULL. The function would fill all the pending alarms in the second parameter. It would fill the count of pending alarms in pPendingAlarms->noOfPendingAlarm and the list of pending alarms in the pPendingAlarms->pAlarmList. The pAlarmList is array of ClAlarmHandleInfoT, so it contains alarm handle and other parameters of the alarm. The alarm handle for the alarm which was raised successfully would be a valid handle generated by alarm server. The alarms which were suppressed, masked or ones for which generation rule didn't satisfy, the alarm handle will be a constant equal to CL_HANDLE_INVALID_VALUE.

Note:: The user need to call the function clAlarmPendingAlarmListFree() in order to free the list of pending alarms.

A pending alarm is the one which is either in assert state (or after soaking), under soaking state, or in suppressed state. The ClAlarmStateT describes all the possible state of an alarm.

Library File:: ClAlarmClient

See Also: clAlarmPendingAlarmListFree()

ClRcT clAlarmRaise	(	CL_IN ClAlarmInfoT *	pAlarmInfo,
		CL_OUT ClAlarmHandleT *	pAlarmHandle
	)

Raises an alarm on a component.

Header File:: clAlarmApi.h

Parameters

alarmInfo	(in)Pointer to the structure that contains the alarm information.
pAlarmHandle	(out)Pointer to the alarm handle. The alarm handle is used by Fault Manager(FM) to query alarm information and pass the alarm information to the fault repair handlers configured by the user.

Return values

CL_OK	The function executed successfully.
CL_ALARM_ERR_INVALID_MOID	On passing invalid MoId, the Managed Object Idetifier.
CL_ALARM_ERR_NO_OWNER	The Managed object passed to the alarm raise doen't have any owner registered in COR.
CL_ALARM_ERR_NULL_POINTER	On passing either pAlarmInfo or the pAlarmHandle as NULL.
CL_ALARM_ERR_INVALID_PARAM	On passing the length of the user buffer (pAlarmInfo->len) as negative or the probable cause (pAlarmInfo->probCause) is not configured.
CL_ALARM_ERR_NO_MEMORY	There is no memory left in this appication to raise the alarm.

Description:: This function is used to generate an alarm on a Managed Object (MO). It can be used by a component to raise an alarm on a resource or on a component itself. While invoking this function, you must fill the ClAlarmInfoT structure which has the following attributes:

moId : The resource on which the alarm is being raised.
compName : The name of component which is raising the alarm.
alarmState : Flag to indicate if the alarm was for assert or for clear.
probCause : Probable cause of the alarm being raised.

There are certain optional fields of the ClAlarmInfoT structure which can be provided while publishing the alarm:

category: The category of the alarm to which it belongs.
specificProblem: Specific problem of the alarm. This is to be specified by user.
severity : Severity of the alarm.
buff : Additional information about the alarm to be specified by the user. This buffer would be allocated by the user and freed after calling this function.
len : Length of the additional data about the alarm.

A unique alarm handle is generated by the alarm server and provided back to the component that raises the alarm. The alarm handle is used by FM to query alarm information and pass the alarm information to the repair handlers configured while modeling.

Library File:: ClAlarmClient

ClRcT clAlarmStateQuery	(	CL_IN const ClAlarmInfoT *	pAlarmInfo,
		CL_OUT ClAlarmStateT *const	pAlarmState
	)

Function to get the current state of the alarm.

Header File:: clAlarmApi.h

Parameters

Parameters

pAlarmInfo	(in) : Pointer to the structure of type ClAlarmInfoT. This structure should be populated with the resource MOID and the alarm information like probable cause, category, severity and specific problem of the alarm.
pAlarmState	(out) : Pointer to the ClAlarmStateT. On successful return, the function would populate the current state of the alarm in this parameter.

Return values

CL_OK	: The function completed successfully.
CL_ERR_NOT_EXIST	: The alarm information doesn't exit on the managed resource.
CL_ALARM_ERR_INVALID_MOID	: The MOID passed is invalid that is no object exist for this MOID in COR.
CL_ALARM_ERR_NO_OWNER	: There is no registered owner for the alarm resource.
CL_ERR_NULL_POINTER	: NULL pointer passed for either pAlarmInfo or pAlarmState.
CL_ERR_NO_MEMORY	: No memory avaible.

Description: The function is used to get the latest state of any alarm. The function takes the alarm information that is the resource MOID, probable cause, specific problem and category. After successful return the pAlarmState would contain the latest state of the alarm provided.

Library File:: ClAlarmClient

See Also: clAlarmPendingAlarmsQuery()

void clAlarmUtilPayloadBufFree ( ClUint8T * pBuf )

The function to free the buffer obtained after flattening the payload information.

Header File:: clAlarmUtils.h

Parameters

pBuf	(in) : The pointer containing the payload information.

Return values

None

Description:: The flat buffer allocated and updated on the successfull execution of the clAlarmUtilPayloadFlatten() should be freed. This is achieved by calling this function.

Library File:: ClAlarmUtils

See Also: clAlarmUtilPayloadFlatten()

ClRcT clAlarmUtilPayLoadExtract	(	ClUint8T *	pBuf,
		ClUint32T	size,
		ClAlarmUtilPayLoadListT **	ppPayloadList
	)

The function to extract the payload information sent at the time of alarm raise.

Header File:: clAlarmUtils.h

Parameters

pBuf	(in) : The pointer containing the payload information. This is the pointer of the payload (buff) obtained from the ClAlarmHandleInfoT of the alarm event delivery callback function.
size	(in) : Size of the payload. This is also obtained from the len element of the alarmInfo element of the ClAlarmHandleInfoT structure provided in the event delivery callback function.
ppPayloadList	(out) : This is the pointer to the ClAlarmUtilPayLoadListT structure which is populated by the function with the payload information sent by the application reported alarm.

Return values

CL_ERR_NULL_POINTER	: The pointer passed to pBuf or ppPayLoadListare NULL.
CL_ERR_NO_MEMORY	: Failed while allocating the memory for the payload information.
CL_OK	: The function completed successfully.

Description:: This function unpacks the the payload buffer sent by the alarm reporter into host format. This buffer contains the payload information packed in certain format. This was done by the alarm reported while raising the alarm. The alarm listener or the SNMP subagent does the job of unpacking the buffer and recreating the payload information. This is done by calling this function. This function allocates the payload buffer in the ppPayloadList argument. This needs to be freed and this can be done by calling clAlarmUtilPayloadListFree().

Library File:: ClAlarmUtils

See Also: clAlarmUtilPayloadListFree()

ClRcT clAlarmUtilPayloadFlatten	(	ClAlarmUtilPayLoadListPtrT	pPayLoadList,
		ClUint32T *	pSize,
		ClUint8T **	ppBuf
	)

Function to convert the payload information into a flat buffer.

Header File:: clAlarmUtils.h

Parameters

pPayLoadList	(in) : The structure containing the payload information.
pSize	(out) : The size of payload information. The value of this field has to be provided to the len element of the ClAlarmInfoT structure.
ppBuf	(out) : The pointer is allocated by the function after flattening the alarm payload information filled in the pPayLoadList. This pointer has to be copied to the buff element of the ClAlarmInfoT structure.

Return values

CL_ERR_NULL_POINTER	: The pointer passed to pPayLoadList, pSize or ppBuf is NULL.
CL_OK	: The function completed successfully.

Description:: This function converts the alarm information into a flat buffer which can be used to provide as alarm payload while reporting the alarm. The function packs the alarm payload details into network byte order and then it puts the information into a flat buffer after allocating it. The size of the buffer is updated into pSize and the buffer is allocated and updated in the ppBuff. The size of the buffer and the buffer could be used to supply it to the element len and buff of the ClAlarmInfoT structure while reporting the alarm. The buffer allocated here has to be freed after raising the alarm, using clAlarmPayloadBufFree(). Also the pPayLoadList which contains the alarm payload information should be freed using the function clAlarmUtilPayloadListFree().

Library File:: ClAlarmUtils

See Also: clAlarmUtilPayloadBufFree(), clAlarmUtilPayloadListFree()

void clAlarmUtilPayloadListFree ( ClAlarmUtilPayLoadListT * pPayloadList )

Function used to free the payload data-structure allocated during alarm reporting or receive.

Header File:: clAlarmUtils.h

Parameters

pPayloadList (in) : This is the pointer to the ClAlarmUtilPayLoadListT structure which is allocated after calling clAlarmUtilPayLoadExtract().

Return values

None

Description:: The pointer pPayloadList has the payload information supplied by the alarm raiser as well after extracting the payload in the alarm event receive function. This payload information is allocated using different structures, which has to be freed. This can be done by calling this function.

Library File:: ClAlarmUtils

See Also: clAlarmUtilPayLoadExtract()

ClRcT clAlarmVersionVerify ( CL_INOUT ClVersionT * pVersion )

This function is used to verify if a version of the function is supported by AM.

Header File:: clAlarmApi.h

Parameters

version (in/out) As an input parameter, this contains the version you require to query or the current version. The output parameter is the Version supported.

Return values

CL_OK	The function executed successfully.
CL_ALARM_ERR_NULL_POINTER	The null pointer is passed for the version parameter.
CL_ALARM_ERR_VERSION_UNSUPPORTED	If current version of this function is not supported.

Description:: This function is used to verify if a version is supported or not. In case the version is not supported, then an error is returned with the value of supported version filled in the output parameter.

Library File:: ClAlarmClient

Files

Classes

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation